Skip to content

Commit 53d8288

Browse files
authored
Post rename updates (#816)
* post merge name changes * some more updates * updates
1 parent 4348562 commit 53d8288

File tree

36 files changed

+124
-123
lines changed

36 files changed

+124
-123
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,23 @@
1414
# limitations under the License.
1515

1616
name: Bug Report
17-
description: File a bug report for Modulus (Core)
17+
description: File a bug report for PhysicsNeMo (Core)
1818
title: "🐛[BUG]: "
1919
labels: ["bug", "? - Needs Triage"]
2020

2121
body:
2222
- type: markdown
2323
attributes:
2424
value: |
25-
Thanks for taking the time to help Modulus and fill out this bug report!
26-
- By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/modulus/blob/main/CONTRIBUTING.md)
27-
- You also confirm that you have searched the [open bugs](https://github.com/NVIDIA/modulus/issues) and have found no duplicates for this request
25+
Thanks for taking the time to help PhysicsNeMo and fill out this bug report!
26+
- By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/physicsnemo/blob/main/CONTRIBUTING.md)
27+
- You also confirm that you have searched the [open bugs](https://github.com/NVIDIA/physicsnemo/issues) and have found no duplicates for this request
2828
2929
- type: input
3030
id: version
3131
attributes:
3232
label: Version
33-
description: What version of Modulus are you running?
33+
description: What version of PhysicsNeMo are you running?
3434
placeholder: "example: 0.9.0"
3535
validations:
3636
required: true

.github/ISSUE_TEMPLATE/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: true
22
contact_links:
33
- name: Ask a Question
4-
url: https://forums.developer.nvidia.com/c/physics-simulation/modulus-physics-ml-model-framework
4+
url: https://forums.developer.nvidia.com/t/welcome-to-the-physicsnemo-ml-model-framework-forum/178556
55
about: Thanks for taking the time to ask us a question!

.github/ISSUE_TEMPLATE/documentation_request.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@
1414
# limitations under the License.
1515

1616
name: Documentation Request
17-
description: Request updates or additions to Modulus (Core) documentation
17+
description: Request updates or additions to PhysicsNeMo (Core) documentation
1818
title: "📚[DOC]: "
1919
labels: ["documentation", "? - Needs Triage"]
2020

2121
body:
2222
- type: markdown
2323
attributes:
2424
value: |
25-
Thanks for taking the time to help Modulus and improve our documentation!
26-
- By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/modulus/blob/main/CONTRIBUTING.md)
27-
- You also confirm that you have searched the [open documentation issues](https://github.com/NVIDIA/modulus/issues) and have found no duplicates for this request
25+
Thanks for taking the time to help PhysicsNeMo and improve our documentation!
26+
- By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/physicsnemo/blob/main/CONTRIBUTING.md)
27+
- You also confirm that you have searched the [open documentation issues](https://github.com/NVIDIA/physicsnemo/issues) and have found no duplicates for this request
2828
2929
- type: dropdown
3030
id: criticality

.github/ISSUE_TEMPLATE/feature_request.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@
1414
# limitations under the License.
1515

1616
name: Feature Request
17-
description: Request new or improved functionality or changes to existing Modulus (Core) functionality
17+
description: Request new or improved functionality or changes to existing PhysicsNeMo (Core) functionality
1818
title: "🚀[FEA]: "
1919
labels: ["enhancement", "? - Needs Triage"]
2020

2121
body:
2222
- type: markdown
2323
attributes:
2424
value: |
25-
Thanks for taking the time to help Modulus and fill out this feature request!
26-
- By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/modulus/blob/main/CONTRIBUTING.md)
27-
- You also confirm that you have searched the [open documentation issues](https://github.com/NVIDIA/modulus/issues) and have found no duplicates for this request
25+
Thanks for taking the time to help PhysicsNeMo and fill out this feature request!
26+
- By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/physicsnemo/blob/main/CONTRIBUTING.md)
27+
- You also confirm that you have searched the [open documentation issues](https://github.com/NVIDIA/physicsnemo/issues) and have found no duplicates for this request
2828
2929
- type: dropdown
3030
id: new_or_improvement

.github/PULL_REQUEST_TEMPLATE.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- markdownlint-disable MD013-->
2-
# Modulus Pull Request
2+
# PhysicsNeMo Pull Request
33

44
## Description
55
<!-- Provide a standalone description of changes in this PR. -->
@@ -8,11 +8,11 @@
88

99
## Checklist
1010

11-
- [ ] I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/modulus/blob/main/CONTRIBUTING.md).
11+
- [ ] I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/physicsnemo/blob/main/CONTRIBUTING.md).
1212
- [ ] New or existing tests cover these changes.
1313
- [ ] The documentation is up to date with these changes.
14-
- [ ] The [CHANGELOG.md](https://github.com/NVIDIA/modulus/blob/main/CHANGELOG.md) is up to date with these changes.
15-
- [ ] An [issue](https://github.com/NVIDIA/modulus/issues) is linked to this pull request.
14+
- [ ] The [CHANGELOG.md](https://github.com/NVIDIA/physicsnemo/blob/main/CHANGELOG.md) is up to date with these changes.
15+
- [ ] An [issue](https://github.com/NVIDIA/physicsnemo/issues) is linked to this pull request.
1616

1717
## Dependencies
1818

.gitlab/issue_templates/bug.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Bug
22

3-
For technical questions please refer to our [forum](https://forums.developer.nvidia.com/c/physics-simulation/modulus-physics-ml-model-framework/443).
3+
For technical questions please refer to our [forum](https://forums.developer.nvidia.com/t/welcome-to-the-physicsnemo-ml-model-framework-forum/178556).
44

55
Before submitting an issue, please review the existing issues to avoid duplicates.
66

@@ -35,12 +35,12 @@ python collect_env.py
3535
- GPU models and configuration:
3636
- Versions of any other relevant libraries:
3737

38-
## Modulus Info
38+
## PhysicsNeMo Info
3939

4040
Please fill out the list below:
4141

42-
- Modulus version:
43-
- How Modulus is used (Docker image/ bare-metal installation):
42+
- PhysicsNeMo version:
43+
- How PhysicsNeMo is used (Docker image/ bare-metal installation):
4444
- (If using OptiX) OptiX version:
4545
- Exact command to reproduce:
46-
- (If using Modulus Docker image): Exact docker-run command:
46+
- (If using PhysicsNeMo Docker image): Exact docker-run command:

.gitlab/issue_templates/documentation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Documentation
22

3-
For technical questions please refer to our [forum](https://forums.developer.nvidia.com/c/physics-simulation/modulus-physics-ml-model-framework/443).
3+
For technical questions please refer to our [forum](https://forums.developer.nvidia.com/t/welcome-to-the-physicsnemo-ml-model-framework-forum/178556).
44

55
Before submitting an issue, please review the existing issues to avoid duplicates.
66

77
For documenation issues, please preface the title with [documentation].
88

99
## The documentation issue
1010

11-
A clear and concise description of what content in Modulus documentation is an issue.
11+
A clear and concise description of what content in PhysicsNeMo documentation is an issue.
1212

1313
## Suggest a potential alternative/fix
1414

.gitlab/issue_templates/feature_request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Feature Request
22

3-
For technical questions please refer to our [forum](https://forums.developer.nvidia.com/c/physics-simulation/modulus-physics-ml-model-framework/443).
3+
For technical questions please refer to our [forum](https://forums.developer.nvidia.com/t/welcome-to-the-physicsnemo-ml-model-framework-forum/178556).
44

55
Before submitting an issue, please review the existing issues to avoid duplicates.
66

.gitlab/issue_templates/security.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Security
22

3-
For technical questions please refer to our [forum](https://forums.developer.nvidia.com/c/physics-simulation/modulus-physics-ml-model-framework/443).
3+
For technical questions please refer to our [forum](https://forums.developer.nvidia.com/t/welcome-to-the-physicsnemo-ml-model-framework-forum/178556).
44

55
Before submitting an issue, please review the existing issues to avoid duplicates.
66

77
For security issues, please preface the title with [security].
88

99
## The Security Issue
1010

11-
If you believe you have found a security vulnerability in Modulus, we encourage you to
11+
If you believe you have found a security vulnerability in PhysicsNeMo, we encourage you to
1212
let us know right away.
1313
We will investigate all legitimate reports and do our best to quickly fix the problem.

.gitlab/merge_request_templates/Default.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Modulus Pull Request
1+
# PhysicsNeMo Pull Request
22

33
## Description
44
<!-- Provide a standalone description of changes in this PR. -->
@@ -7,10 +7,10 @@
77

88
## Checklist
99

10-
- [ ] I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/modulus/blob/main/CONTRIBUTING.md).
10+
- [ ] I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/physicsnemo/blob/main/CONTRIBUTING.md).
1111
- [ ] New or existing tests cover these changes.
1212
- [ ] The documentation is up to date with these changes.
13-
- [ ] The [CHANGELOG.md](https://github.com/NVIDIA/modulus/blob/main/CHANGELOG.md) is
13+
- [ ] The [CHANGELOG.md](https://github.com/NVIDIA/physicsnemo/blob/main/CHANGELOG.md) is
1414
up to date with these changes.
1515

1616
## Dependencies

.pre-commit-config.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ repos:
1919
rev: 22.10.0
2020
hooks:
2121
- id: black
22-
exclude: "(docs|modulus/experimental)"
22+
exclude: "(docs|physicsnemo/experimental)"
2323

2424
- repo: https://github.com/econchick/interrogate
2525
rev: 1.7.0
@@ -31,7 +31,7 @@ repos:
3131
"--ignore-magic", "--fail-under=99", "--exclude=['setup.py', 'test', 'build', 'docs']",
3232
"--ignore-regex=['forward', 'backward', 'reset_parameters', 'extra_repr', 'MetaData', 'apply_activation','exec_activation']",
3333
"--color", "--"]
34-
exclude: ^modulus/internal/|^modulus/experimental/|^docs/
34+
exclude: ^physicsnemo/internal/|^physicsnemo/experimental/|^docs/
3535

3636
- repo: https://github.com/igorshubovych/markdownlint-cli
3737
rev: v0.35.0

CITATION.cff

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
cff-version: 1.2.0
22
message: "If you use this software, please cite it as below."
3-
title: "NVIDIA Modulus: An open-source framework for physics-based deep learning in science and engineering"
3+
title: "NVIDIA PhysicsNeMo: An open-source framework for physics-based deep learning in science and engineering"
44
date-released: "2023-02-24"
55
authors:
6-
- name: "Modulus Contributors"
7-
repository-code: "https://github.com/NVIDIA/modulus"
6+
- name: "PhysicsNeMo Contributors"
7+
repository-code: "https://github.com/NVIDIA/physicsnemo"

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ contributing to the project. One way to do this is to create an issue discussing
1818
your thoughts. It might be that a very similar feature is under development or
1919
already exists, so an issue is a great starting point. If you are looking for an
2020
issue to resolve that will help, refer to the
21-
[issue](https://github.com/NVIDIA/modulus/issues) section.
21+
[issue](https://github.com/NVIDIA/physicsnemo/issues) section.
2222
If you are considering collaborating with NVIDIA PhysicsNeMo team to enhance PhysicsNeMo,
2323
fill this [proposal form](https://forms.gle/fYsbZEtgRWJUQ3oQ9) and
2424
we will get back to you.
@@ -30,7 +30,7 @@ we will get back to you.
3030
Developer workflow for code contributions is as follows:
3131

3232
1. Developers must first [fork](https://help.github.com/en/articles/fork-a-repo)
33-
the [upstream](https://github.com/NVIDIA/Modulus) PhysicsNeMo repository.
33+
the [upstream](https://github.com/NVIDIA/physicsnemo) PhysicsNeMo repository.
3434

3535
2. Git clone the forked repository and push changes to the personal fork.
3636

@@ -215,8 +215,8 @@ The pipeline has following stages:
215215
To run pytest locally you can simply run `pytest` inside the `test` folder.
216216
217217
While writing these tests, we encourage you to make use of the
218-
[`@nfs_data_or_fail`](https://github.com/NVIDIA/modulus/blob/main/test/pytest_utils.py#L92)
219-
and the [`@import_of_fail`](https://github.com/NVIDIA/modulus/blob/main/test/pytest_utils.py#L25)
218+
[`@nfs_data_or_fail`](https://github.com/NVIDIA/physicsnemo/blob/main/test/pytest_utils.py#L92)
219+
and the [`@import_of_fail`](https://github.com/NVIDIA/physicsnemo/blob/main/test/pytest_utils.py#L25)
220220
decorators to appropriately skip your tests for developers and users not having your
221221
test specific datasets and dependencies respectively. The CI has these datasets and
222222
dependencies so your tests will get executed during CI.

Dockerfile

+2-2
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ ENV DGLBACKEND=$DGL_BACKEND
9494
ARG DGL_ARM64_WHEEL
9595
ENV DGL_ARM64_WHEEL=${DGL_ARM64_WHEEL:-unknown}
9696

97-
# TODO: this is a workaround as dgl is not yet shipping arm compatible wheels for CUDA 12.x: https://github.com/NVIDIA/modulus/issues/432
97+
# TODO: this is a workaround as dgl is not yet shipping arm compatible wheels for CUDA 12.x: https://github.com/NVIDIA/physicsnemo/issues/432
9898
RUN if [ "$TARGETPLATFORM" = "linux/arm64" ] && [ "$DGL_ARM64_WHEEL" != "unknown" ]; then \
9999
echo "Custom DGL wheel $DGL_ARM64_WHEEL for $TARGETPLATFORM exists, installing!" && \
100100
pip install --no-cache-dir --no-deps /physicsnemo/deps/${DGL_ARM64_WHEEL}; \
@@ -135,7 +135,7 @@ ARG TARGETPLATFORM
135135
# TODO: Remove hacky downgrade of netCDF4 package. netCDF4 v1.7.1 has following
136136
# issue: https://github.com/Unidata/netcdf4-python/issues/1343
137137
# This workaround is only added for the CI systems which run pytest only once.
138-
# For more details, refer: https://github.com/NVIDIA/modulus/issues/608
138+
# For more details, refer: https://github.com/NVIDIA/physicsnemo/issues/608
139139
RUN pip install --no-cache-dir "netcdf4>=1.6.3,<1.7.1"
140140

141141
RUN pip install --no-cache-dir "mlflow>=2.1.1"

FAQ.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
## What is the recommended hardware for training using PhysicsNeMo framework?
1212

1313
Please refer to the recommended hardware section:
14-
[System Requirments](https://docs.nvidia.com/deeplearning/modulus/getting-started/index.html#system-requirements)
14+
[System Requirments](https://docs.nvidia.com/deeplearning/physicsnemo/getting-started/index.html#system-requirements)
1515

1616
## What model architectures are in PhysicsNeMo?
1717

@@ -24,8 +24,8 @@ model architecture can be applied to a specific problem.
2424
These are reference starting points for users to get started.
2525

2626
You can find the list of built in model architectures
27-
[here](https://github.com/NVIDIA/modulus/tree/main/modulus/models) and
28-
[here](https://github.com/NVIDIA/modulus-sym/tree/main/modulus/sym/models)
27+
[here](https://github.com/NVIDIA/physicsnemo/tree/main/physicsnemo/models) and
28+
[here](https://github.com/NVIDIA/physicsnemo-sym/tree/main/physicsnemo/sym/models)
2929

3030
## What is the difference between PhysicsNeMo Core and Symbolic?
3131

@@ -38,23 +38,23 @@ abstraction to compose a training loop from specification of the geometry, PDEs
3838
constraints like boundary conditions using simple symbolic APIs.
3939
So if you are familiar with PyTorch and want to train model from a dataset, you start
4040
with PhysicsNeMo core and you import PhysicsNeMo symbolic to bring in explicit domain knowledge.
41-
Please refer to the [DeepONet example](https://github.com/modulus/tree/main/examples/cfd/darcy_deeponet_physics)
41+
Please refer to the [DeepONet example](https://github.com/physicsnemo/tree/main/examples/cfd/darcy_deeponet_physics)
4242
that illustrates the concept.
4343
If you are an engineer or domain expert accustomed to using numerical solvers, you can
4444
use PhysicsNeMo Symbolic to define your problem at a higher level of abstraction. Please
45-
refer to the [Lid Driven cavity](https://docs.nvidia.com/deeplearning/modulus/modulus-sym/user_guide/basics/lid_driven_cavity_flow.html)
45+
refer to the [Lid Driven cavity](https://docs.nvidia.com/deeplearning/physicsnemo/physicsnemo-sym/user_guide/basics/lid_driven_cavity_flow.html)
4646
that illustrates the concept.
4747

4848
## What can I do if I dont see a PDE in PhysicsNeMo?
4949

5050
PhysicsNeMo Symbolic provides a well documeted
51-
[example](https://docs.nvidia.com/deeplearning/modulus/modulus-sym/user_guide/foundational/1d_wave_equation.html#writing-custom-pdes-and-boundary-initial-conditions)
52-
that walks you through how to define a custom PDE. Please see the source [here](https://github.com/NVIDIA/modulus-sym/tree/main/modulus/sym/eq/pdes)
51+
[example](https://docs.nvidia.com/deeplearning/physicsnemo/physicsnemo-sym/user_guide/foundational/1d_wave_equation.html#writing-custom-pdes-and-boundary-initial-conditions)
52+
that walks you through how to define a custom PDE. Please see the source [here](https://github.com/NVIDIA/physicsnemo-sym/tree/main/physicsnemo/sym/eq/pdes)
5353
to see the built-in PDE implementation as an additional reference for your own implementation.
5454

5555
## What is the difference between the pip install and the container?
5656

5757
There is no functional difference between the two. This is to simplify the ease of
5858
installing and setting up the PhysicsNeMo environment. Please refer to the
59-
[getting started guide](https://docs.nvidia.com/deeplearning/modulus/getting-started/index.html#modulus-with-docker-image-recommended)
59+
[getting started guide](https://docs.nvidia.com/deeplearning/physicsnemo/getting-started/index.html#physicsnemo-with-docker-image-recommended)
6060
on how to install using Pip or using the container.

0 commit comments

Comments
 (0)