Skip to content
Accurate Neural Network Potential on PyTorch
Python Shell
Branch: master
Clone or download
zasdfgbnm and farhadrgh Move unittest check to GitHub Actions (#317)
* Move unittest check to GitHub Actions

Tests are parallelized

* Delete tests.yml

* Update setup.py

* Create test_requirements.txt

* Update unittest.yml

* Update unittest.yml

* Update README.md

* Delete install_dependencies.sh

* Delete install_dependencies_python2.sh

* Update unittest.yml
Latest commit c67ec7d Sep 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Move unittest check to GitHub Actions (#317) Sep 23, 2019
azure Move unittest check to GitHub Actions (#317) Sep 23, 2019
ci Move python2 check to GitHub Actions (#318) Sep 23, 2019
dataset Remove all large files and stop using git-lfs (#289) Aug 13, 2019
docs Fix dependency in setup.py: `torch-nightly` has been renamed to `torc… Aug 22, 2019
examples Use a modified Sequential class with type annotation (#308) Sep 22, 2019
tests Use a modified Sequential class with type annotation (#308) Sep 22, 2019
tools New Dataset API add other properties (#300) Aug 25, 2019
torchani Use a modified Sequential class with type annotation (#308) Sep 22, 2019
.gitignore Remove all large files and stop using git-lfs (#289) Aug 13, 2019
.gitmodules Tools for COMP6 benchmark (#196) Mar 23, 2019
CODEOWNERS Add @farhadrgh as a code owner for everything (#246) Jun 6, 2019
LICENSE Changes for publicity, step 1, license, logo, and CI (#100) Sep 26, 2018
MANIFEST.in torchani 0.1 Jul 20, 2018
README.md Move unittest check to GitHub Actions (#317) Sep 23, 2019
download.sh Change download URL to dropbox (#291) Aug 13, 2019
logo1.png Changes for publicity, step 1, license, logo, and CI (#100) Sep 26, 2018
logo2.png [ImgBot] Optimize images (#132) Oct 30, 2018
setup.cfg New dataset API, cached dataset and shuffled dataset (#284) Aug 20, 2019
setup.py Move unittest check to GitHub Actions (#317) Sep 23, 2019
test_requirements.txt Move unittest check to GitHub Actions (#317) Sep 23, 2019

README.md

Accurate Neural Network Potential on PyTorch

Checks:

CodeFactor Total alerts

Deploy (these builds only succeed on tagged commits):

Build Status Build Status

TorchANI is a pytorch implementation of ANI. It is currently under alpha release, which means, the API is not stable yet. If you find a bug of TorchANI, or have some feature request, feel free to open an issue on GitHub, or send us a pull request.

Install

TorchANI requires the latest preview version of PyTorch. You can install PyTorch by the following commands (assuming cuda10):

pip install numpy
pip install --pre torch torchvision -f https://download.pytorch.org/whl/nightly/cu100/torch_nightly.html

If you updated TorchANI, you may also need to update PyTorch:

pip install --upgrade --pre torch torchvision -f https://download.pytorch.org/whl/nightly/cu100/torch_nightly.html

After installing the correct PyTorch, you can install TorchANI by:

pip install torchani

See also PyTorch's official site for instructions of installing latest preview version of PyTorch.

Please install nightly PyTorch through pip install instead of conda install. If your PyTorch is installed through conda install, then pip would mistakenly recognize the package name as torch instead of torch-nightly, which would cause dependency issue when installing TorchANI.

To run the tests and examples, you must manually download a data package

./download.sh

Paper

The original ANI-1 paper is:

  • Smith JS, Isayev O, Roitberg AE. ANI-1: an extensible neural network potential with DFT accuracy at force field computational cost. Chemical science. 2017;8(4):3192-203.

We are planning a seperate paper for TorchANI, it will be available when we are ready for beta release of TorchANI.

See also: isayev/ASE_ANI

Develop

To install TorchANI from GitHub:

git clone https://github.com/aiqm/torchani.git
cd torchani
pip install -e .

After TorchANI has been installed, you can build the documents by running sphinx-build docs build. But make sure you install dependencies:

pip install sphinx sphinx-gallery pillow matplotlib sphinx_rtd_theme

To manually run unit tests, do python setup.py nosetests

Note to TorchANI developers

Never commit to the master branch directly. If you need to change something, create a new branch, submit a PR on GitHub.

You must pass all the tests on GitHub before your PR can be merged.

Code review is required before merging pull request.

You can’t perform that action at this time.