Metadata-Version: 2.1
Name: nvidia-modulus
Version: 0.1.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: h5py (>=3.7.0)
Requires-Dist: netcdf4 (>=1.6.3)
Requires-Dist: numpy (>=1.22.4)
Requires-Dist: nvidia-dali-cuda110 (>=1.16.0)
Requires-Dist: pytest (>=6.0.0)
Requires-Dist: setuptools (>=67.6.0)
Requires-Dist: torch (>=1.12)
Provides-Extra: inference
Requires-Dist: onnxruntime (==1.13.1) ; extra == 'inference'

# Modulus (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)](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)

Modulus is a PyTorch based deep-learning toolkit for developing deep learning models for physical systems. This package aims to provide useful utilities for physics-constrained and data-driven workflows.

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

  NVIDIA Modulus

## 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.git && cd modulus

pip install --upgrade pip
pip install .
```

## Docker

To build Modulus docker image:
```
docker build -t modulus:deploy --target deploy -f Dockerfile .
```
Alternatively, you can run `make container-deploy`

To build CI image:
```
docker build -t modulus:ci --target ci -f Dockerfile .
```
Alternatively, you can run `make container-ci`


## 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 is provided under the Apache License 2.0, please see [LICENSE.txt](./LICENSE.txt) for full license text.
