diff --git a/README.rst b/README.rst index 455209a..bcf392d 100644 --- a/README.rst +++ b/README.rst @@ -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 `_, 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. @@ -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. \ No newline at end of file +For a more detailed tutorial on how to use the module, please refer to the tutorial notebook in the `tutorials` folder.