Skip to content

Commit

Permalink
added more detailed description for installing the code in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Dingel321 committed Mar 5, 2024
1 parent d4d340a commit 53a039c
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://lampe.readthedocs.io/en/stable/>`_.
2. `SciPy <https://scipy.org/>`_.
Expand All @@ -25,9 +36,6 @@ Dependencies
5. json
6. `mrcfile <https://pypi.org/project/mrcfile/>`_.

Installing
----------

Download this repository
~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: bash
Expand Down Expand Up @@ -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.

0 comments on commit 53a039c

Please sign in to comment.