Metadata-Version: 2.1
Name: nvidia-modulus.sym
Version: 1.0.0
Summary: A deep learning framework for AI-driven multi-physics systems
Author: NVIDIA Modulus Team
License: Apache 2.0
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: nvidia-modulus @ git+https://github.com/NVIDIA/modulus.git@main
Requires-Dist: hydra-core (>=1.2.0)
Requires-Dist: termcolor (>=2.1.1)
Requires-Dist: chaospy (>=4.3.7)
Requires-Dist: Cython (==0.29.28)
Requires-Dist: numpy-stl (==2.16.3)
Requires-Dist: opencv-python (==4.5.5.64)
Requires-Dist: scikit-learn (==1.0.2)
Requires-Dist: symengine (==0.6.1)
Requires-Dist: sympy (==1.5.1)
Requires-Dist: timm (==0.5.4)
Requires-Dist: torch-optimizer (==0.3.0)
Requires-Dist: transforms3d (==0.3.1)
Requires-Dist: typing (==3.7.4.3)
Requires-Dist: vtk (==9.1.0)
Requires-Dist: pillow (==9.3.0)
Requires-Dist: notebook (==6.4.12)
Requires-Dist: mistune (==2.0.3)
Requires-Dist: pint (==0.19.2)

# Modulus Sym (Beta)

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![GitHub](https://img.shields.io/github/license/NVIDIA/modulus-sym)](https://github.com/NVIDIA/modulus-sym/blob/master/LICENSE.txt)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Modulus-Sym is a repo with an abstracted workflow comparable to existing numerical solvers for training data-free and data-driven neural models.

**This is an early-access alpha release**

## Modulus Packages

- [Modulus (Beta)](https://github.com/NVIDIA/modulus)
- [Modulus Launch (Beta)](https://github.com/NVIDIA/modulus-launch)
- [Modulus Symbolic (Beta)](https://github.com/NVIDIA/modulus-sym)

## Installing 

Modulus is coming to PyPi soon! In the mean time the best way is to install from source:

```Bash
git clone git@github.com:NVIDIA/modulus-sym.git && cd modulus-sym
```

```Bash
pip install .
```

## Docker

To build release image, you will need to do the below preliminary steps:

Clone this repo, and download the Optix SDK from https://developer.nvidia.com/designworks/optix/downloads/legacy. 
```
git clone https://github.com/NVIDIA/modulus-sym.git
cd modulus-sym/ && mkdir deps
```
Currently Modulus supports v7.0. Place the Optix file in the deps directory and make it executable. Also clone the pysdf library in the deps folder (NVIDIA Internal)
```
chmod +x deps/NVIDIA-OptiX-SDK-7.0.0-linux64.sh 
git clone <internal pysdf repo>
```

Then to build the image, insert next tag and run below:
```
docker build -t modulus-sym -f Dockerfile .
```

Alternatively, if you want to skip pysdf installation, you can run the following:
```
docker build -t modulus-sym -f Dockerfile --target no-pysdf .
```

## Contributing

Modulus is in an open-source beta. We are not accepting external contributions at this time.

## Contact

Reach out to Modulus team members and user community on the [NVIDIA developer forums](https://forums.developer.nvidia.com/c/physics-simulation/modulus-physics-ml-model-framework).

## License
Modulus Symbolic is provided under the Apache License 2.0, please see [LICENSE.txt](./LICENSE.txt) for full license text
