Metadata-Version: 2.1
Name: nvidia-modulus.launch
Version: 0.1.0
Summary: Optimized tranining recipes for accelerating PyTorch workflows of AI driven surrogates for physical 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: wandb (>=0.13.7)
Requires-Dist: mlflow (>=2.1.1)
Requires-Dist: pytest (>=6.0.0)
Requires-Dist: pydantic (>=1.10.2)

# Modulus Launch (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-launch)](https://github.com/NVIDIA/modulus-launch/blob/master/LICENSE.txt)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Modulus Launch is a PyTorch based deep-learning collection of training recipes and tools for creating physical surrogates. The
goal of this repository is to provide a collection of deep learning training examples for different phenomena as starting points
for academic and industrial applications.

**This is an early-access beta 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-launch.git && cd modulus-launch
```

```Bash
pip install .
```

## Docker

To build Modulus Launch docker image:
```
docker build -t modulus-launch:deploy --target deploy -f Dockerfile .
```

To build CI image:
```
docker build -t modulus-launch:ci --target ci -f Dockerfile .
```

To build any of these images on top of the Modulus base image, you can `--build-arg BASE_CONTAINER=modulus:deploy` to the above commands as shown below:
```
docker build --build-arg BASE_CONTAINER=modulus:deploy -t modulus-launch:deploy --target deploy -f Dockerfile .
```


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