diff --git a/README.md b/README.md index c6e1bb4762e65ad91e58d4e85037ab152da0ab8b..2b0b78127245aead85c9a96013109ea2b574c419 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,19 @@ 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: +### Header + +The first cell of the notebook should follow the pattern: ``` # Title of the notebook Notebook author: Author name (author@email.dk) - -Short description paragraph +Short paragraph that describes the contents of the Notebook. ## Dependencies -Explain how to install non-standard libraries that are needed for the notebook to run, or point to resources +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. @@ -25,3 +26,32 @@ The reference can be created using the Qim Platform API, that follows this patte `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. + +### Location + +Notebooks should be placed according to their intended usage. New directories can be suggested, but the current structure is the following: + +``` +. +├── analysis +│  └── structure_orientation +├── data +├── detection +├── reconstruction +├── resources +│  ├── img2d +│  ├── img3d +│  └── libs +├── segmentation +└── visualization + +``` + +The `resources` directory should not contain Notebooks, but any data that is required for other Notebooks to run. + +Small python libraries can be located in the `libs`directory. And they can be imported by adding the directory to the path: +``` +import sys +sys.path.append("../../resources/libs/") + +```