Metadata-Version: 2.1
Name: physicsml
Version: 0.5.0
Summary: A package for all physics based/related models
Author: Exscientia
Maintainer: Exscientia
Project-URL: documentation, https://exscientia.github.io/physicsml/
Project-URL: repository, https://github.com/exscientia/physicsml.git
Project-URL: issue-tracker, https://github.com/exscientia/physicsml/issues
Project-URL: changelog, https://github.com/exscientia/physicsml/src/main/CHANGELOG.md
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: molflux[lightning] >=0.5.0
Requires-Dist: torch-geometric >=2.5.0
Requires-Dist: e3nn
Requires-Dist: torchani !=2.2.4
Provides-Extra: ase
Requires-Dist: rdkit ; extra == 'ase'
Requires-Dist: ase ; extra == 'ase'
Provides-Extra: dev
Requires-Dist: nox[uv] ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx !=5.1.0 ; extra == 'docs'
Requires-Dist: sphinx-sitemap ; extra == 'docs'
Requires-Dist: sphinx-inline-tabs ; extra == 'docs'
Requires-Dist: sphinx-book-theme ; extra == 'docs'
Requires-Dist: sphinx-design ; extra == 'docs'
Requires-Dist: sphinx-toolbox ; extra == 'docs'
Requires-Dist: sphinx-togglebutton ; extra == 'docs'
Requires-Dist: jupytext >=1.11.2 ; extra == 'docs'
Requires-Dist: myst-nb ; extra == 'docs'
Requires-Dist: ipywidgets ; extra == 'docs'
Requires-Dist: rdkit >=2023.9.1 ; extra == 'docs'
Requires-Dist: matplotlib ; extra == 'docs'
Requires-Dist: ase ; extra == 'docs'
Provides-Extra: openeye
Requires-Dist: openeye-toolkits ; extra == 'openeye'
Provides-Extra: openmm
Requires-Dist: rdkit ; extra == 'openmm'
Provides-Extra: rdkit
Requires-Dist: rdkit ; extra == 'rdkit'
Provides-Extra: tests
Requires-Dist: coverage[toml] ; extra == 'tests'
Requires-Dist: coverage-badge ; extra == 'tests'
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: h5py ; extra == 'tests'
Provides-Extra: typing
Requires-Dist: mypy ; extra == 'typing'
Requires-Dist: types-PyYAML ; extra == 'typing'
Requires-Dist: types-setuptools ; extra == 'typing'

![Logo Dark](docs/source/_static/PhysicsML_Logo_PhyML_logo%20full%20light-cropped.svg#gh-dark-mode-only)
![Logo Light](docs/source/_static/PhysicsML_Logo_PhyML_logo%20full%20dark-cropped.svg#gh-light-mode-only)

---

[![PyPI version](https://img.shields.io/pypi/v/physicsml)](https://pypi.org/project/physicsml/)
[![Supported Python versions](https://img.shields.io/badge/python-3.10%20%7C%203.11-blue.svg)](https://docs.python.org/3/whatsnew/index.html)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/charliermarsh/ruff)
[![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue)](http://mypy-lang.org/)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)


---

## What is PhysicsML?

PhysicsML is a package for all physics based/related models. It provides a standardised interface for handling, building,
and training 3d models!

## Installation
### With pip

```bash
pip install physicsml
```

#### Optional Dependencies

Some functionalities in `physicsml` require additional dependencies, which you can install as needed. For example

```bash
pip install physicsml[rdkit]
```

## Documentation

To learn more about how to use ``physicsml``, see the [documentation](https://exscientia.github.io/physicsml/).

## Contribution guidelines

Anyone is welcome to submit PRs for new functionality or fixes! Just create a pull request and we will review and get back to
you.

## License
[MIT License](LICENSE)

## Acknowledgements

The ``physicsml`` package has been developed by researchers at Exscientia

* Adam Baskerville
* Aayush Gupta
* Ward Haddadin
* Kavindri Ranasinghe
* Ben Suutari
