Skip to content

Commit

Permalink
update README with information on git lfs
Browse files Browse the repository at this point in the history
  • Loading branch information
DSilva27 committed Aug 5, 2024
1 parent c5b2276 commit 3fae22e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ pip install .
```

## Developer installation

First of all, make sure to have git lfs installed, otherwise you will have no access to the testing data. For installing, please follow these [guidelines](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage).

If you are interested in testing the programs previously installed, please, install the repository in development mode with the following commands:

```bash
Expand All @@ -52,7 +55,6 @@ The test included in the repo can be executed with PyTest as shown below:

```bash
cd /path/to/Cryo-EM-Heterogeneity-Challenge-1
sh tests/scripts/fetch_test_data.sh # download test data from OSF
pytest tests/test_preprocessing.py
pytest tests/test_svd.py
pytest tests/test_map_to_map.py
Expand Down

0 comments on commit 3fae22e

Please sign in to comment.