diff --git a/README.md b/README.md index bc320eff31d07e47a99615f9d75af776ab229671..c6e1bb4762e65ad91e58d4e85037ab152da0ab8b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ # QIM Notebooks This repository contains a curated list of Jupyter Notebooks suitable for serveral tasks related to QIM and Image analysis in general. + +# Contribution +The first cell of the notebook should follow the pattern: + + +``` +# Title of the notebook +Notebook author: Author name (author@email.dk) + + +Short description paragraph + +## Dependencies +Explain how to install non-standard libraries that are needed for the notebook to run, or point to resources + +## Reference this work +In case the main library used for the notebook is part of a publication, the reference should be inserted here. + +``` + +The reference can be created using the Qim Platform API, that follows this pattern: +`https://platform.qim.dk/qim-api/reference/<doi address>` + +For example, accessing the address https://platform.qim.dk/qim-api/reference/10.1109/CVPRW59228.2023.00456 will give you the markdown text for this particular DOI. It can then be easily copied and pasted into the jupyter notebook.