nvidia-physicsnemo 1.0.0__py3-none-any.whl

nvidia_physicsnemo-1.0.0.dist-info/LICENSE.txt

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 NVIDIA Corporation
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

nvidia_physicsnemo-1.0.0.dist-info/METADATA

@@ -0,0 +1,451 @@
+Metadata-Version: 2.2
+Name: nvidia-physicsnemo
+Version: 1.0.0
+Summary: A deep learning framework for AI-driven multi-physics systems
+Author: NVIDIA PhysicsNeMo Team
+License: Apache 2.0
+Project-URL: Homepage, https://github.com/NVIDIA/modulus
+Project-URL: Documentation, https://docs.nvidia.com/modulus/#core
+Project-URL: Issues, https://github.com/NVIDIA/modulus/issues
+Project-URL: Changelog, https://github.com/NVIDIA/modulus/blob/main/CHANGELOG.md
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: certifi>=2023.7.22
+Requires-Dist: fsspec>=2023.1.0
+Requires-Dist: numpy>=1.22.4
+Requires-Dist: nvidia_dali_cuda120>=1.35.0
+Requires-Dist: onnx>=1.14.0
+Requires-Dist: s3fs>=2023.5.0
+Requires-Dist: setuptools>=67.6.0
+Requires-Dist: timm>=0.9.12
+Requires-Dist: torch>=2.0.0
+Requires-Dist: tqdm>=4.60.0
+Requires-Dist: treelib>=1.2.5
+Requires-Dist: xarray>=2023.1.0
+Requires-Dist: zarr>=2.14.2
+Provides-Extra: launch
+Requires-Dist: hydra-core>=1.2.0; extra == "launch"
+Requires-Dist: termcolor>=2.1.1; extra == "launch"
+Requires-Dist: wandb>=0.13.7; extra == "launch"
+Requires-Dist: mlflow>=2.1.1; extra == "launch"
+Requires-Dist: pydantic>=2.4.2; extra == "launch"
+Requires-Dist: imageio>=2.28.1; extra == "launch"
+Requires-Dist: moviepy>=1.0.3; extra == "launch"
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0.0; extra == "dev"
+Requires-Dist: pyyaml>=6.0; extra == "dev"
+Requires-Dist: black==22.10.0; extra == "dev"
+Requires-Dist: interrogate==1.5.0; extra == "dev"
+Requires-Dist: coverage==6.5.0; extra == "dev"
+Requires-Dist: ruff==0.0.290; extra == "dev"
+Provides-Extra: makani
+Requires-Dist: torch-harmonics<0.7.1,>=0.6.5; extra == "makani"
+Requires-Dist: tensorly>=0.8.1; extra == "makani"
+Requires-Dist: tensorly-torch>=0.4.0; extra == "makani"
+Provides-Extra: fignet
+Requires-Dist: jaxtyping>=0.2; extra == "fignet"
+Requires-Dist: torch_scatter>=2.1; extra == "fignet"
+Requires-Dist: torchinfo>=1.8; extra == "fignet"
+Requires-Dist: warp-lang>=1.0; extra == "fignet"
+Requires-Dist: webdataset>=0.2; extra == "fignet"
+Provides-Extra: storage
+Requires-Dist: multi-storage-client>=0.14.0; extra == "storage"
+Provides-Extra: shardtensor
+Requires-Dist: wrapt>=1.15.0; extra == "shardtensor"
+Provides-Extra: all
+Requires-Dist: h5py>=3.7.0; extra == "all"
+Requires-Dist: netcdf4>=1.6.3; extra == "all"
+Requires-Dist: ruamel.yaml>=0.17.22; extra == "all"
+Requires-Dist: scikit-learn>=1.0.2; extra == "all"
+Requires-Dist: scikit-image>=0.24.0; extra == "all"
+Requires-Dist: warp-lang>=1.0; extra == "all"
+Requires-Dist: vtk>=9.2.6; extra == "all"
+Requires-Dist: pyvista>=0.40.1; extra == "all"
+Requires-Dist: cftime>=1.6.2; extra == "all"
+Requires-Dist: einops>=0.7.0; extra == "all"
+Requires-Dist: pyspng>=0.1.0; extra == "all"
+Requires-Dist: shapely>=2.0.6; extra == "all"
+Requires-Dist: pytz>=2023.3; extra == "all"
+Requires-Dist: nvtx>=0.2.8; extra == "all"
+Requires-Dist: nvidia-physicsnemo[launch]; extra == "all"
+Requires-Dist: nvidia-physicsnemo[dev]; extra == "all"
+Requires-Dist: nvidia-physicsnemo[makani]; extra == "all"
+Requires-Dist: nvidia-physicsnemo[fignet]; extra == "all"
+Requires-Dist: nvidia-physicsnemo[storage]; extra == "all"
+
+# NVIDIA PhysicsNeMo
+
+<!-- markdownlint-disable -->
+
+📝 NVIDIA Modulus has been renamed to NVIDIA PhysicsNeMo
+
+[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![GitHub](https://img.shields.io/github/license/NVIDIA/modulus)](https://github.com/NVIDIA/modulus/blob/master/LICENSE.txt)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+<!-- markdownlint-enable -->
+[**Getting Started**](#getting-started)
+| [**Install guide**](#installation)
+| [**Contributing Guidelines**](#contributing-to-physicsnemo)
+| [**Resources**](#resources)
+| [**Communication**](#communication)
+| [**License**](#license)
+
+## What is PhysicsNeMo?
+
+NVIDIA PhysicsNeMo is an open-source deep-learning framework for building, training,
+and fine-tuning deep learning models using state-of-the-art SciML methods for
+AI4science and engineering.
+
+PhysicsNeMo provides utilities and optimized pipelines to develop AI models that combine
+physics knowledge with data, enabling real-time predictions.
+
+Whether you are exploring the use of Neural operators, GNNs, or transformers or are
+interested in Physics-informed Neural Networks or a hybrid approach in between, PhysicsNeMo
+provides you with an optimized stack that will enable you to train your models at scale.
+
+<!-- markdownlint-disable -->
+<p align="center">
+  <img src=https://raw.githubusercontent.com/NVIDIA/modulus/main/docs/img/value_prop/Knowledge_guided_models.gif alt="PhysicsNeMo"/>
+</p>
+<!-- markdownlint-enable -->
+
+<!-- toc -->
+
+- [More About PhysicsNeMo](#more-about-physicsnemo)
+  - [Scalable GPU-optimized training Library](#scalable-gpu-optimized-training-library)
+  - [A suite of Physics-Informed ML Models](#a-suite-of-physics-informed-ml-models)
+  - [Seamless PyTorch Integration](#seamless-pytorch-integration)
+  - [Easy Customization and Extension](#easy-customization-and-extension)
+  - [AI4Science Library](#ai4science-library)
+    - [Domain Specific Packages](#domain-specific-packages)
+- [Who is contributing to PhysicsNeMo](#who-is-using-and-contributing-to-physicsnemo)
+- [Why use PhysicsNeMo](#why-are-they-using-physicsnemo)
+- [Getting Started](#getting-started)
+- [Resources](#resources)
+- [Installation](#installation)
+- [Contributing](#contributing-to-physicsnemo)
+- [Communication](#communication)
+- [License](#license)
+  
+<!-- tocstop -->
+
+## More About PhysicsNeMo
+
+At a granular level, PhysicsNeMo provides a library of a few key components:
+
+<!-- markdownlint-disable -->
+Component | Description |
+---- | --- |
+[**modules.models**](https://docs.nvidia.com/deeplearning/modulus/modulus-core/api/modulus.models.html) | A collection of optimized, customizable, and easy-to-use models such as Fourier Neural Operators, Graph Neural Networks, and many more|
+[**physicsnemo.datapipes**](https://docs.nvidia.com/deeplearning/modulus/modulus-core/api/modulus.datapipes.html) | A data pipeline and data loader library, including benchmark datapipes, weather daptapipes, and graph datapipes|
+[**physicsnemo.distributed**](https://docs.nvidia.com/deeplearning/modulus/modulus-core/api/modulus.distributed.html) | A distributed computing library build on top of `torch.distributed` to enable parallel training with just a few steps|
+[**physicsnemo.sym.geometry**](https://docs.nvidia.com/deeplearning/modulus/modulus-sym/user_guide/features/csg_and_tessellated_module.html) | A library to handle geometry for DL training using the Constructive Solid Geometry modeling and CAD files in STL format.|
+[**physicsnemo.sym.eq**](https://docs.nvidia.com/deeplearning/modulus/modulus-sym/user_guide/features/nodes.html) | A library to use PDEs in your DL training with several implementations of commonly observed equations and easy ways for customization.|
+<!-- markdownlint-enable -->
+
+For a complete list, refer to the PhysicsNeMo API documentation for
+[PhysicsNeMo Core](https://docs.nvidia.com/deeplearning/modulus/modulus-core/index.html)
+and
+[PhysicsNeMo Sym](https://docs.nvidia.com/deeplearning/modulus/modulus-sym/api/api_index.html).
+
+Usually, PhysicsNeMo is used either as:
+
+- A complementary tool to Pytorch when exploring AI for SciML and AI4Science applications.
+- A deep learning research platform that provides scale and optimal performance on
+NVIDIA GPUs.
+
+Elaborating Further:
+
+### Scalable GPU-optimized training Library
+
+PhysicsNeMo provides a highly optimized and scalable training library for maximizing the
+power of NVIDIA GPUs.
+[Distributed computing](https://docs.nvidia.com/deeplearning/modulus/modulus-core/api/modulus.distributed.html)
+utilities allow for efficient scaling from a single GPU to multi-node GPU clusters with
+a few lines of code, ensuring that large-scale.
+physics-informed machine learning (ML) models can be trained quickly and effectively.
+The framework includes support for advanced.
+[optimization utilities](https://docs.nvidia.com/deeplearning/modulus/modulus-core/api/modulus.utils.html#module-modulus.utils.capture),
+[tailor made datapipes](https://docs.nvidia.com/deeplearning/modulus/modulus-core/api/modulus.datapipes.html),
+[validation utilities](https://github.com/NVIDIA/modulus-sym/tree/main/modulus/sym/eq)
+to enhance the end to end training speed.
+
+### A suite of Physics Informed ML Models
+
+PhysicsNeMo offers a comprehensive library of state-of-the-art models specifically designed
+for physics-ML applications.
+The [Model Zoo](https://docs.nvidia.com/deeplearning/modulus/modulus-core/api/modulus.models.html#model-zoo)
+includes generalizable model architectures such as
+[Fourier Neural Operators (FNOs)](physicsnemo/models/fno),
+[DeepONet](https://docs.nvidia.com/deeplearning/modulus/modulus-sym/user_guide/neural_operators/deeponet.html),
+[Physics-Informed Neural Networks (PINNs)](https://docs.nvidia.com/deeplearning/modulus/modulus-sym/user_guide/foundational/1d_wave_equation.html),
+[Graph Neural Networks (GNNs)](physicsnemo/models/gnn_layers),
+and generative AI models like [Diffusion Models](physicsnemo/models/diffusion)
+as well as domain-specific models such as [Deep Learning Weather Prediction (DLWP)](physicsnemo/models/dlwp)
+and [Super Resolution Network (SrNN)](physicsnemo/models/srrn) among others.
+These models are optimized for various physics domains, such as computational fluid
+dynamics, structural mechanics, and electromagnetics. Users can download, customize, and
+build upon these models to suit their specific needs, significantly reducing the time
+required to develop high-fidelity simulations.
+
+### Seamless PyTorch Integration
+
+PhysicsNeMo is built on top of PyTorch, providing a familiar and user-friendly experience
+for those already proficient with PyTorch.
+This includes a simple Python interface and modular design, making it easy to use
+PhysicsNeMo with existing PyTorch workflows.
+Users can leverage the extensive PyTorch ecosystem, including its libraries and tools
+while benefiting from PhysicsNeMo's specialized capabilities for physics-ML. This seamless
+integration ensures users can quickly adopt PhysicsNeMo without a steep learning curve.
+
+For more information, refer [Converting PyTorch Models to PhysicsNeMo Models](https://docs.nvidia.com/deeplearning/modulus/modulus-core/api/modulus.models.html#converting-pytorch-models-to-modulus-models)
+
+### Easy Customization and Extension
+
+PhysicsNeMo is designed to be highly extensible, allowing users to add new functionality
+with minimal effort. The framework provides Pythonic APIs for
+defining new physics models, geometries, and constraints, making it easy to extend its
+capabilities to new use cases.
+The adaptability of PhysicsNeMo is further enhanced by key features such as
+[ONNX support](https://docs.nvidia.com/deeplearning/modulus/modulus-core/api/modulus.deploy.html)
+for flexible model deployment,
+robust [logging utilities](https://docs.nvidia.com/deeplearning/modulus/modulus-core/api/modulus.launch.logging.html)
+for streamlined error handling,
+and efficient
+[checkpointing](https://docs.nvidia.com/deeplearning/modulus/modulus-core/api/modulus.launch.utils.html#module-modulus.launch.utils.checkpoint)
+to simplify model loading and saving.
+
+This extensibility ensures that PhysicsNeMo can adapt to the evolving needs of researchers
+and engineers, facilitating the development of innovative solutions in the field of physics-ML.
+
+Detailed information on features and capabilities can be found in the [PhysicsNeMo documentation](https://docs.nvidia.com/modulus/index.html#core).
+
+[Reference samples](examples/README.md) cover a broad spectrum of physics-constrained
+and data-driven
+workflows to suit the diversity of use cases in the science and engineering disciplines.
+
+> [!TIP]
+> Have questions about how PhysicsNeMo can assist you? Try our [Experimental] chatbot,
+> [PhysicsNeMo Guide](https://chatgpt.com/g/g-PXrBv20SC-modulus-guide), for answers.
+
+### Hello world
+
+You can start using PhysicsNeMo in your PyTorch code as simple as shown here:
+
+```python
+python
+>>> import torch
+>>> from physicsnemo.models.mlp.fully_connected import FullyConnected
+>>> model = FullyConnected(in_features=32, out_features=64)
+>>> input = torch.randn(128, 32)
+>>> output = model(input)
+>>> output.shape
+torch.Size([128, 64])
+```
+
+### AI4Science Library
+
+- [PhysicsNeMo Symbolic](https://github.com/NVIDIA/modulus-sym): This repository of
+  algorithms and utilities allows SciML researchers and developers to physics inform model
+  training and model validation. It also provides a higher level abstraction
+  for domain experts that is native to science and engineering.
+
+#### Domain Specific Packages
+
+The following are packages dedicated for domain experts of specific communities catering
+to their unique exploration needs.
+
+- [Earth-2 Studio](https://github.com/NVIDIA/earth2studio): Open source project
+  to enable climate researchers and scientists to explore and experiment with
+  AI models for weather and climate.
+
+#### Research packages
+
+The following are research packages that get packaged into PhysicsNeMo once they are stable.
+
+- [PhysicsNeMo Makani](https://github.com/NVIDIA/modulus-makani): Experimental library
+  designed to enable the research and development of machine-learning based weather and
+  climate models.
+- [Earth2 Grid](https://github.com/NVlabs/earth2grid): Experimental library with
+  utilities for working geographic data defined on various grids.
+- [Earth-2 MIP](https://github.com/NVIDIA/earth2mip): Experimental library with
+  utilities for model intercomparison for weather and climate models.
+
+## Who is using and contributing to PhysicsNeMo
+
+PhysicsNeMo is an open source project and gets contributions from researchers in
+the SciML and AI4science fields. While PhysicsNeMo team works on optimizing the
+underlying SW stack, the community collaborates and contributes model architectures,
+datasets, and reference applications so we can innovate in the pursuit of
+developing generalizable model architectures and algorithms.
+
+Some latest examples of community contributors are [HP Labs 3D Printing team](https://developer.nvidia.com/blog/spotlight-hp-3d-printing-and-nvidia-modulus-collaborate-on-open-source-manufacturing-digital-twin/),
+[Stanford Cardiovascular research team](https://developer.nvidia.com/blog/enabling-greater-patient-specific-cardiovascular-care-with-ai-surrogates/),
+[UIUC team](https://github.com/NVIDIA/modulus/tree/main/examples/cfd/mhd_pino),
+[CMU team](https://github.com/NVIDIA/modulus/tree/main/examples/generative/diffusion) etc.
+
+Latest examples of research teams using PhysicsNeMo are
+[ORNL team](https://arxiv.org/abs/2404.05768),
+[TU Munich CFD team](https://www.nvidia.com/en-us/on-demand/session/gtc24-s62237/) etc.
+
+Please navigate to this page for a complete list of research work leveraging PhysicsNeMo.
+For a list of enterprises using PhysicsNeMo refer [here](https://developer.nvidia.com/modulus).
+
+Using PhysicsNeMo and interested in showcasing your work on
+[NVIDIA Blogs](https://developer.nvidia.com/blog/category/simulation-modeling-design/)?
+Fill out this [proposal form](https://forms.gle/XsBdWp3ji67yZAUF7) and we will get back
+to you!
+
+## Why are they using PhysicsNeMo
+
+Here are some of the key benefits of PhysicsNeMo for SciML model development:
+
+<!-- markdownlint-disable -->
+<img src="docs/img/value_prop/benchmarking.svg" width="100"> | <img src="docs/img/value_prop/recipe.svg" width="100"> | <img src="docs/img/value_prop/performance.svg" width="100">
+---|---|---|
+|SciML Benchmarking and validation|Ease of using generalized SciML recipes with heterogenous datasets |Out of the box performance and scalability
+|PhysicsNeMo enables researchers to benchmark their AI model against proven architectures for standard benchmark problems with detailed domain-specific validation criteria.|PhysicsNeMo enables researchers to pick from SOTA SciML architectures and use built-in data pipelines for their use case.| PhysicsNeMo provides out-of-the-box performant training pipelines including optimized ETL pipelines for heterogrneous engineering and scientific datasets and out of the box scaling across multi-GPU and multi-node GPUs.
+<!-- markdownlint-enable -->
+
+See what your peer SciML researchers are saying about PhysicsNeMo (Coming soon).
+
+## Getting started
+
+The following resources will help you in learning how to use PhysicsNeMo. The best
+way is to start with a reference sample and then update it for your own use case.
+
+- [Using PhysicsNeMo with your PyTorch model](https://docs.nvidia.com/deeplearning/modulus/modulus-core/tutorials/simple_training_example.html#using-custom-models-in-modulus)
+- [Using PhysicsNeMo built-in models](https://docs.nvidia.com/deeplearning/modulus/modulus-core/tutorials/simple_training_example.html#using-built-in-models)
+- [Getting started Guide](https://docs.nvidia.com/deeplearning/modulus/getting-started/index.html)
+- [Reference Samples](https://github.com/NVIDIA/modulus/blob/main/examples/README.md)
+- [User guide Documentation](https://docs.nvidia.com/deeplearning/modulus/modulus-core/index.html)
+
+## Resources
+
+- [Getting started Webinar](https://www.nvidia.com/en-us/on-demand/session/gtc24-dlit61460/?playlistId=playList-bd07f4dc-1397-4783-a959-65cec79aa985)
+- [AI4Science PhysicsNeMo Bootcamp](https://github.com/openhackathons-org/End-to-End-AI-for-Science)
+- [PhysicsNeMo Pretrained models](https://catalog.ngc.nvidia.com/models?filters=&orderBy=scoreDESC&query=Modulus&page=&pageSize=)
+- [PhysicsNeMo Datasets and Supplementary materials](https://catalog.ngc.nvidia.com/resources?filters=&orderBy=scoreDESC&query=Modulus&page=&pageSize=)
+- [Self-paced PhysicsNeMo DLI training](https://learn.nvidia.com/courses/course-detail?course_id=course-v1:DLI+S-OV-04+V1)
+- [Deep Learning for Science and Engineering Lecture Series with PhysicsNeMo](https://www.nvidia.com/en-us/on-demand/deep-learning-for-science-and-engineering/)
+  - [PhysicsNeMo: purpose and usage](https://www.nvidia.com/en-us/on-demand/session/dliteachingkit-setk5002/)
+- [Video Tutorials](https://www.nvidia.com/en-us/on-demand/search/?facet.mimetype[]=event%20session&layout=list&page=1&q=modulus&sort=relevance&sortDir=desc)
+  
+## Installation
+
+### PyPi
+
+The recommended method for installing the latest version of PhysicsNeMo is using PyPi:
+
+```Bash
+pip install nvidia-physicsnemo
+```
+
+The installation can be verified by running the hello world example as demonstrated [here](#hello-world).
+
+#### Optional dependencies
+
+PhysicsNeMo has many optional dependencies that are used in specific components.
+When using pip, all dependencies used in PhysicsNeMo can be installed with
+`pip install nvidia-physicsnemo[all]`. If you are developing PhysicsNeMo, developer dependencies
+can be installed using `pip install nvidia-physicsnemo[dev]`. Otherwise, additional dependencies
+can be installed on a case by case basis. Detailed information on installing the
+optional dependencies can be found in the
+[Getting Started Guide](https://docs.nvidia.com/deeplearning/modulus/getting-started/index.html).
+
+### NVCR Container
+
+The recommended PhysicsNeMo docker image can be pulled from the
+[NVIDIA Container Registry](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/modulus/containers/modulus)
+(refer to the NGC registry for the latest tag):
+
+```Bash
+docker pull nvcr.io/nvidia/physicsnemo/physicsnemo:25.03
+```
+
+Inside the container, you can clone the PhysicsNeMo git repositories and get
+started with the examples. The below command shows the instructions to launch
+the physicsnemo container and run examples from this repo.
+
+```bash
+docker run --shm-size=1g --ulimit memlock=-1 --ulimit stack=67108864 --runtime nvidia \
+--rm -it nvcr.io/nvidia/physicsnemo/physicsnemo:25.03 bash
+git clone https://github.com/NVIDIA/physicsnemo.git
+cd physicsnemo/examples/cfd/darcy_fno/
+pip install warp-lang # install NVIDIA Warp to run the darcy example
+python train_fno_darcy.py
+```
+
+For enterprise supported NVAIE container, refer [PhysicsNeMo Secured Feature Branch](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/modulus/containers/modulus-sfb)
+
+## From Source
+
+### Package
+
+For a local build of the PhysicsNeMo Python package from source use:
+
+```Bash
+git clone git@github.com:NVIDIA/physicsnemo.git && cd physicsnemo
+
+pip install --upgrade pip
+pip install .
+```
+
+### Source Container
+
+To build PhysicsNeMo docker image:
+
+```bash
+docker build -t physicsnemo:deploy \
+    --build-arg TARGETPLATFORM=linux/amd64 --target deploy -f Dockerfile .
+```
+
+Alternatively, you can run `make container-deploy`
+
+To build CI image:
+
+```bash
+docker build -t physicsnemo:ci \
+    --build-arg TARGETPLATFORM=linux/amd64 --target ci -f Dockerfile .
+```
+
+Alternatively, you can run `make container-ci`.
+
+Currently, only `linux/amd64` and `linux/arm64` platforms are supported. If using
+`linux/arm64`, some dependencies like `warp-lang` might not install correctly.
+
+## Contributing to PhysicsNeMo
+
+PhysicsNeMo is an open source collaboration and its success is rooted in community
+contribution to further the field of Physics-ML. Thank you for contributing to the
+project so others can build on top of your contribution.
+
+For guidance on contributing to PhysicsNeMo, please refer to the
+[contributing guidelines](CONTRIBUTING.md).
+
+## Cite PhysicsNeMo
+
+If PhysicsNeMo helped your research and you would like to cite it, please refer to the [guidelines](https://github.com/NVIDIA/modulus/blob/main/CITATION.cff)
+
+## Communication
+
+- Github Discussions: Discuss new architectures, implementations, Physics-ML research, etc.
+- GitHub Issues: Bug reports, feature requests, install issues, etc.
+- PhysicsNeMo Forum: The [PhysicsNeMo Forum](https://forums.developer.nvidia.com/c/physics-simulation/modulus-physics-ml-model-framework)
+hosts an audience of new to moderate-level users and developers for general chat, online
+discussions, collaboration, etc.
+
+## Feedback
+
+Want to suggest some improvements to PhysicsNeMo? Use our feedback form
+[here](https://docs.google.com/forms/d/e/1FAIpQLSfX4zZ0Lp7MMxzi3xqvzX4IQDdWbkNh5H_a_clzIhclE2oSBQ/viewform?usp=sf_link).
+
+## License
+
+PhysicsNeMo is provided under the Apache License 2.0, please see [LICENSE.txt](./LICENSE.txt)
+for full license text. Enterprise SLA, support and preview access are available
+under NVAIE.