Skip to content

Commit

Permalink
readme formatting (#71)
Browse files Browse the repository at this point in the history
  • Loading branch information
McHaillet authored Dec 13, 2023
1 parent d7ef10b commit cfd0854
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,25 @@ nvidia-cuda-toolkit

## Installation

There are 2 options for creating a conda environment. (1 - recommended) Create a new environment with a prebuild cupy version and complete CUDA-toolkit. This is reliable but takes more disk space:
There are 2 options for creating a conda environment:

```commandline
conda create -n pytom_tm -c conda-forge python=3 cupy cuda-version=11.8
```
1. **(recommended)** Create a new environment with a prebuild cupy version and complete CUDA-toolkit. This is reliable but takes more disk space.

```commandline
conda create -n pytom_tm -c conda-forge python=3 cupy cuda-version=11.8
```
(2) Create an environment without cupy and let pip build against a system installed CUDA-toolkit:
2. Create a new environment without cupy and let pip build against a system installed CUDA-toolkit.
`conda create -n pytom_tm python=3`
```commandline
conda create -n pytom_tm python=3
```
Once the environment is created, activate it:
`conda activate pytom_tm`
```commandline
conda activate pytom_tm
```

Then clone the repository and install it with pip:

Expand All @@ -37,7 +43,7 @@ python -m pip install '.[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 fucntionality, 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
pip install .
python -m pip install .
```

## Tests
Expand Down

0 comments on commit cfd0854

Please sign in to comment.