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.

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

update readme to point to pip install instead of source #139

Merged
merged 4 commits into from
Mar 1, 2024
Merged
Changes from all commits
Commits
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
45 changes: 32 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,33 +35,28 @@ Once the environment is created, activate it:
conda activate pytom_tm
```

Then clone the repository and install it with pip (building cupy can take a while!):
Then install the code with `pip` (building cupy can take a while!):

```commandline
git clone https://github.com/SBC-Utrecht/pytom-match-pick.git
cd pytom-match-pick
python -m pip install '.[plotting]'
python -m pip install pytom-match-pick[plotting]
```

The installation above also adds the optional dependencies `[matplotlib, seaborn]` which are required to run
`pytom_estimate_roc.py`. They are not essential to the core template matching functionality, so for some systems
(such as certain cluster environments) it might be desirable to skip them. In that case remove `[plotting]` from the pip install command:

```commandline
python -m pip install .
python -m pip install pytom-match-pick
```

## Tests

To run the unittests:

## Cupy warning
Having issues running the software? If cupy is not correctly installed,
```commandline
cd tests
python -m unittest discover
python -c "import pytom_tm"
```

If cupy is not correctly installed, this should raise some errors:

can show a cupy warning. If this is the case, this probably means cupy is not correctly installed.
McHaillet marked this conversation as resolved.
Show resolved Hide resolved
Alternatively, cupy can sometimes be installed without issue but not detect CUDA correctly. In that case, the following should raise some errors:
```commandline
python -c "import cupy as cp; a = cp.zeros((100,100))"
```
Expand All @@ -85,6 +80,30 @@ The following scripts are available to run with `--help` to see parameters:
- estimate an ROC curve from a job file (.json): `pytom_estimate_roc.py --help`
- merge multiple star files to a single starfile: `pytom_merge_stars.py --help`

## Developer install
If you want the most up-to-date version of the code you can get install it from this repository via:

```commandline
git clone https://github.com/SBC-Utrecht/pytom-match-pick.git
cd pytom-match-pick
python -m pip install '.[plotting]'
```

as above, if you don't want the optional plotting dependencies use the following install command instead:
```commandline
python -m pip install .
```

## Tests

With the developer install also comes the ability to run the unittests,
from the git repository run:

```commandline
cd tests
python -m unittest discover
```

## Contributing

Contributions to the project are very welcome! Feel free to make a pull request or suggest an implementation in the issues. For PR's we will gladly give you feedback on how to integrate the code.
Expand Down
Loading