From 53a039c0b6e53f55707923bb221d8398d28b13ae Mon Sep 17 00:00:00 2001 From: Dingel321 Date: Tue, 5 Mar 2024 19:09:25 +0100 Subject: [PATCH] added more detailed description for installing the code in the readme --- README.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 574b268..455209a 100644 --- a/README.rst +++ b/README.rst @@ -15,8 +15,19 @@ cryoSBI - Simulation-based Inference for Cryo-EM :alt: Testing Status :target: https://github.com/DSilva27/cryo_em_SBI/actions +Installing +---------- +To install the module you will have to dowload the repository and create a virtual environment with the required dependencies. +You can create an environment for example with conda using the following command: + +.. code:: bash + + conda create -n cryoSBI python=3.10 + +After creating the virtual environment, you should install the required dependencies and the module. + Dependencies ------------- +~~~~~~~~~~~~ 1. `Lampe `_. 2. `SciPy `_. @@ -25,9 +36,6 @@ Dependencies 5. json 6. `mrcfile `_. -Installing ----------- - Download this repository ~~~~~~~~~~~~~~~~~~~~~~~~ .. code:: bash @@ -118,3 +126,8 @@ Sampling from the posterior distribution can be done using the sample_posterior batch_size=100, device="cuda", ) + + +Tutorial +-------- +For a more detailed tutorial on how to use the module, please refer to the tutorial notebook in the `tutorials` folder. \ No newline at end of file