Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Dingel321 authored Mar 5, 2024
1 parent 53a039c commit 7453820
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ cryoSBI - Simulation-based Inference for Cryo-EM
:alt: Testing Status
:target: https://github.com/DSilva27/cryo_em_SBI/actions

Summary
-------
cryoSBI is a Python module for simulation-based inference in cryo-electron microscopy. The module provides tools for simulating cryo-EM particles, training an amortized posterior model, and sampling from the posterior distribution.
The code is based on the SBI libary `Lampe <https://lampe.readthedocs.io/en/stable/>`_, which is a using Pytorch.

Installing
----------
To install the module you will have to dowload the repository and create a virtual environment with the required dependencies.
Expand Down Expand Up @@ -130,4 +135,4 @@ Sampling from the posterior distribution can be done using the sample_posterior
Tutorial
--------
For a more detailed tutorial on how to use the module, please refer to the tutorial notebook in the `tutorials` folder.
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 7453820

Please sign in to comment.