Skip to content

Commit 9245be8

Browse files
committed
Install and test updates
1 parent c672121 commit 9245be8

2 files changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ Then activate the environment and install the following dependencies:
4343

4444
```bash
4545
conda activate diffnets
46-
conda install -c conda-forge numpy=2.3 scipy=1.16 cython=3.2 pytest=9.0 matplotlib=3.10 pandas=2.3 mdtraj=1.11 mpi4py=4.1
46+
conda install -c conda-forge numpy=2.3 scipy=1.16 cython=3.2 pytest=9.0 matplotlib=3.10 pandas=2.3 scikit-learn=1.8.0 mdtraj=1.11 mpi4py=4.1
4747
```
4848

49-
Next install CUDA-enabled PyTorch:
49+
Next install CUDA-enabled PyTorch (recommend CUDA 12.1):
5050
```bash
5151
pip install torch==2.2.2 torchvision==0.17.2 torchaudio==2.2.2 --index-url https://download.pytorch.org/whl/cu121
5252
```
@@ -89,6 +89,12 @@ Again if no messages pop up, then DiffNets is properly installed!
8989

9090
DiffNets uses sphinx for documentation. They are a work in progress, but can be found [here.](https://diffnets.readthedocs.io/en/latest/)
9191

92+
We use pytest for testing.
93+
```bash
94+
cd tests
95+
pytest
96+
```
97+
9298
## Brief tutorial
9399

94100
For a brief tutorial on how to use DiffNets as a command line interface (cli) please visit our documentation page [here.](https://diffnets.readthedocs.io/en/latest/Tutorial.html) We recommend using the CLI to get started with diffnets.

environment.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ dependencies:
1111
- cython=3.2
1212
- pytest=9.0
1313
- matplotlib=3.10
14+
- scikit-learn=1.8.0
1415
- pandas=2.3
1516
- mpi4py=4.1
1617
- pip:

0 commit comments

Comments
 (0)