From 22a6280f1cbd99075786a7987d1e39ee2df5cf1f Mon Sep 17 00:00:00 2001
From: marvinfriede <51965259+marvinfriede@users.noreply.github.com>
Date: Fri, 5 Jan 2024 14:52:49 +0100
Subject: [PATCH] Fix links
---
README.md | 7 ++++---
docs/installation.rst | 9 +++++++++
2 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 8156dc4..459624e 100644
--- a/README.md
+++ b/README.md
@@ -97,8 +97,8 @@ pip install .
The following dependencies are required
- [numpy](https://numpy.org/)
-- [tad_mctc](https://github.com/tad-mctc/tad_mctc/)
-- [tad_multicharge](https://github.com/tad-mctc/tad_multicharge/)
+- [tad-mctc](https://github.com/tad-mctc/tad-mctc/)
+- [tad-multicharge](https://github.com/tad-mctc/tad-multicharge/)
- [torch](https://pytorch.org/)
- [pytest](https://docs.pytest.org/) (tests only)
@@ -107,7 +107,8 @@ The following dependencies are required
For development, additionally install the following tools in your environment.
```bash
-mamba install black covdefaults coverage mypy pre-commit pylint tox
+mamba install black covdefaults mypy pre-commit pylint pytest pytest-cov pytest-xdist tox
+pip install pytest-random-order
```
With pip, add the option ``-e`` for installing in development mode, and add ``[dev]`` for the development dependencies
diff --git a/docs/installation.rst b/docs/installation.rst
index ad56194..de675c4 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -31,6 +31,15 @@ Install the required dependencies from the conda-forge channel.
mamba env create -n torch -f environment.yaml
mamba activate torch
+The following dependencies are required
+
+- `numpy `__
+- `tad-mctc `__
+- `tad-multicharge `__
+- `torch `__
+- `pytest `__ (tests only)
+
+
Development
~~~~~~~~~~~