From e2975217e77f1555ac10d815ab31ff54227e6bf0 Mon Sep 17 00:00:00 2001 From: geoffwoollard Date: Wed, 26 Jun 2024 11:15:10 -0400 Subject: [PATCH] Update README.md with commands and acknowledgements --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 66636c8..7f57a20 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,15 @@ cd /path/to/Cryo-EM-Heterogeneity-Challenge-1 pip install . ``` -You are all set. If you want to run our code, please check the notebooks in the folder called "tutorials". +## Running +If you want to run our code, please check the notebooks in the folder called "tutorials". The tutorials explain how to setup the config files, and run the commands +``` +cryo_challenge run_preprocessing --config config_files/config_preproc.yaml +cryo_challenge run_svd --config config_files/config_svd.yaml +cryo_challenge run_map2map_pipeline --config config_files/config_map_to_map.yaml +cryo_challenge run_distribution2distribution_pipeline --config config_files/config_distribution_to_distribution.yaml +``` ## Acknowledgements +* Miro A. Astore, Geoffrey Woollard, David Silva-Sánchez, Wenda Zhao, Khanh Dao Duc, Nikolaus Grigorieff, Pilar Cossio, and Sonya M. Hanson. "The Inaugural Flatiron Institute Cryo-EM Heterogeneity Community Challenge". 9 June 2023. DOI:10.17605/OSF.IO/8H6FZ +* David Herreros for testing and CI and debugging in this repo