diff --git a/tutorials/README.md b/tutorials/README.md new file mode 100644 index 0000000..d427ba5 --- /dev/null +++ b/tutorials/README.md @@ -0,0 +1,28 @@ +# Brief overview + +There are notebook tutorials for the each step in the analysis pipeline. + +### `1_tutorial_preprocessing.ipynb` +This notebok walks through how to align the raw submissions, and the various options in this step. +- input: folders with respective 80 `.mrc` files and a `populations.txt` file +- output: anonymized `submission_?.pt` files with aligned populations + + +### `2_tutorial_svd.ipynb` +This notebook walks through generating and analyzing (plots) the SVD results. +- input: `submission_?.pt` files +- output: `svd_results.pt` + + +### `3_tutorial_map2map.ipynb` +This notebook walks through generating and analyzing (plots) the map to map distance matrix results. +- input: one `submission_?.pt` file +- output: a `.pkl` file + + +### `4_tutorial_distribution2distribution.ipynb` +- input: one `.pkl` file from the map2map step +- output: a `.pkl` file + +### `5_tutorial_plotting.ipynb` +This notebook walks through parsing and analyzing (plots) the map to map and distribution to distribution results. \ No newline at end of file