From 9ed4e05dfac17ee0ddbda15f6de7d38afc083eac Mon Sep 17 00:00:00 2001 From: Marten <58044494+McHaillet@users.noreply.github.com> Date: Wed, 13 Dec 2023 14:05:28 +0100 Subject: [PATCH] readme formatting --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d8654c65..a372b35d 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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