Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Tom Freudenberg <[email protected]>
  • Loading branch information
Tom Freudenberg committed Jun 20, 2024
1 parent a780187 commit 612d0fe
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,27 +80,29 @@ Installation
============
TorchPhysics reqiueres the follwing dependencies to be installed:

- Python >= 3.8
- PyTorch_ >= 2.0.0
- `PyTorch Lightning`_ >= 2.0.0
- Numpy_ >= 1.20.2
- Matplotlib_ >= 3.0.0
- Scipy_ >= 1.6.3

To install the TorchPhysics version that is compatible with PyTorch>=2.0.0
you have to copy this branch and install it manually, either by
To install TorchPhysics you can run the following code in any Python environment where ``pip`` is installed

.. code-block:: python
pip install "git+https://github.com/boschresearch/torchphysics@Version2.0"
pip install torchphysics
or by
Or by

.. code-block:: python
git clone https://github.com/boschresearch/torchphysics@Version2.0
git clone https://github.com/boschresearch/torchphysics
cd path_to_torchphysics_folder
pip install .[all]
if you want to modify the code.

.. _Numpy: https://numpy.org/
.. _Matplotlib: https://matplotlib.org/
.. _Scipy: https://scipy.org/
Expand Down

0 comments on commit 612d0fe

Please sign in to comment.