Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update installation guide to mention conda #525

Merged
merged 1 commit into from
Nov 6, 2020
Merged

Update installation guide to mention conda #525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,25 @@ TorchANI is a pytorch implementation of ANI. It is currently under alpha release

# Install

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

```bash
pip install numpy
pip install --pre torch torchvision -f https://download.pytorch.org/whl/nightly/cu100/torch_nightly.html
```
Please see [PyTorch's official site](https://pytorch.org/get-started/locally/) for instructions of installing latest preview version of PyTorch.

Note that if you updated TorchANI, you may also need to update PyTorch.

If you updated TorchANI, you may also need to update PyTorch:
After installing the correct PyTorch, you can install TorchANI by `pip` or `conda`:

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

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

```bash
pip install torchani
conda install -c conda-forge torchani
```

See also [PyTorch's official site](https://pytorch.org/get-started/locally/) for instructions of installing latest preview version of PyTorch.
See https://github.com/conda-forge/torchani-feedstock for more information about the conda package.

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

Expand Down
18 changes: 8 additions & 10 deletions docs/start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,25 @@
Installation
============

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

.. code-block:: bash
Please see `PyTorch's official site`_ for instructions of installing latest preview version of PyTorch.

pip install numpy
pip install --pre torch torchvision -f https://download.pytorch.org/whl/nightly/cu100/torch_nightly.html
Note that if you updated TorchANI, you may also need to update PyTorch.

If you updated TorchANI, you may also need to update PyTorch:
After installing the correct PyTorch, you can install TorchANI by `pip` or `conda`:

.. code-block:: bash

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

pip install torchani

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

.. code-block:: bash

pip install torchani
conda install -c conda-forge torchani

See also `PyTorch's official site`_ for instructions of installing latest preview version of PyTorch.
See https://github.com/conda-forge/torchani-feedstock for more information about the conda package.

.. _PyTorch's official site:
https://pytorch.org/get-started/locally/