Merge pull request #13 from bmandracchia/nightly

Nightly
bmandracchia · Sep 1, 2024 · 7a3155c · 7a3155c
2 parents 8d3573c + f64ea2c
commit 7a3155c
Show file tree

Hide file tree

Showing 98 changed files with 4,828,920 additions and 9,865 deletions.
diff --git a/README.md b/README.md
@@ -2,22 +2,147 @@
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
-This file will become your README and also the index of your
-documentation.
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+![Python Version](https://img.shields.io/badge/python-3.7+-blue.svg)
+![Jupyter
+Notebook](https://img.shields.io/badge/jupyter-%23f37626.svg?style=flat&logo=jupyter&logoColor=white)
 
-## Install
+## Overview
 
-``` sh
-pip install bioMONAI
-```
+bioMONAI is a collaborative platform for developing and deploying deep
+learning models in medical imaging using the MONAI framework and Jupyter
+notebooks. This project aims to facilitate interoperability,
+reproducibility, and community collaboration in biomedical research.
 
+## Table of Contents
 
-## How to use
+- [bioMONAI](#biomonai)
+  - [Overview](#overview)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Getting Started](#getting-started)
+  - [Usage](#usage)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Contact](#contact)
 
-Fill me in please! Don’t forget code examples:
+## Installation
 
-``` python
-1+1
-```
+To install the BioMONAI nbs environment, follow these steps:
 
-    2
+1.  **Clone the repository:**
+
+    ``` bash
+    git clone https://github.com/bmandracchia/biomonai.git
+    cd biomonai-nbs
+    ```
+
+2.  **Create a new Conda environment (recommended):**
+
+    ``` bash
+    conda create -n biomonai python=3.7
+    conda activate biomonai
+    ```
+
+3.  **Install dependencies:**
+
+    ``` bash
+    pip install -r requirements.txt
+    ```
+
+4.  **Install MONAI and other necessary packages:**
+
+    ``` bash
+    pip install bioMONAI
+    ```
+
+## Getting Started
+
+To get started with BioMONAI nbs, follow these steps:
+
+1.  **Clone the repository:**
+
+    ``` bash
+    git clone https://github.com/your_username/biomonai-nbs.git
+    cd biomonai-nbs
+    ```
+
+2.  **Activate your Conda environment:**
+
+    ``` bash
+    conda activate biomonai
+    ```
+
+3.  **Open Jupyter Notebook:**
+
+    ``` bash
+    jupyter notebook
+    ```
+
+4.  **Navigate to the notebooks directory and open a sample notebook:**
+
+    - You should see a list of available notebooks in your browser. Open
+      one to start exploring!
+
+## Usage
+
+To use BioMONAI nbs for your own projects, follow these steps:
+
+1.  **Create a new Jupyter notebook or open an existing one.**
+
+2.  **Import necessary modules:**
+
+    ``` python
+    import bioMONAI
+    ```
+
+3.  **Start coding! You can now leverage MONAI’s capabilities alongside
+    the interactive features of Jupyter notebooks.**
+
+## Contributing
+
+We welcome contributions from the community! To contribute to BioMONAI
+nbs, follow these steps:
+
+1.  **Fork the repository on GitHub.**
+
+2.  **Clone your fork:**
+
+    ``` bash
+    git clone https://github.com/your_username/biomonai-nbs.git
+    cd biomonai-nbs
+    ```
+
+3.  **Create a new branch for your changes:**
+
+    ``` bash
+    git checkout -b feature/new-feature
+    ```
+
+4.  **Make your changes and commit them:**
+
+    ``` bash
+    git add .
+    git commit -m "Add new feature: <feature description>"
+    ```
+
+5.  **Push to your fork and create a pull request on GitHub.**
+
+6.  **Wait for the review, and merge if everything looks good!**
+
+## License
+
+BioMONAI nbs is released under the Apache 2.0 license. See
+[LICENSE](https://github.com/your_username/biomonai-nbs/blob/main/LICENSE)
+for more details.
+
+------------------------------------------------------------------------
+
+## Contact
+
+If you have any questions or need further assistance, please open an
+issue on GitHub or contact us directly at:
+
+- Project Lead: [Biagio Mandracchia](mailto:biagio.mandracchia@uva.es)
+- Contributors: [Contributor
+  Names](mailto:contributor1@example.com,%20contributor2@example.com)
diff --git a/_proc/.quarto/idx/00_core.ipynb.json b/_proc/.quarto/idx/00_core.ipynb.json
@@ -1 +1 @@
-{"title":"core","markdown":{"yaml":{"description":"bioMONAI core","output-file":"core.html","title":"core"},"headingText":"Dataloaders","containsRefs":false,"markdown":"\n\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n\nGet the ground truth images located in a folder called 'gt' and divided in labeled subfolders.\n\n> These function are tailor-made for some test datasets, eventually they must be changed/adapted to more general cases\n\nGet as ground truth another noisy image randomly chosen in the same folder as the input image\n\n## Utils\n\n## Display 3D images\n\nFunction to display the 3D volume in axial, coronal or sagittal reconstruction. The display functions does not consider the spacing between pixels, so reconstructions may look unusual. \n\n# Other functions\n\nfeatures to be implemented\n","srcMarkdownNoYaml":"\n\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Dataloaders\n\nGet the ground truth images located in a folder called 'gt' and divided in labeled subfolders.\n\n> These function are tailor-made for some test datasets, eventually they must be changed/adapted to more general cases\n\nGet as ground truth another noisy image randomly chosen in the same folder as the input image\n\n## Utils\n\n## Display 3D images\n\nFunction to display the 3D volume in axial, coronal or sagittal reconstruction. The display functions does not consider the spacing between pixels, so reconstructions may look unusual. \n\n# Other functions\n\nfeatures to be implemented\n"},"formats":{"html":{"identifier":{"display-name":"HTML","target-format":"html","base-format":"html"},"execute":{"fig-width":7,"fig-height":5,"fig-format":"retina","fig-dpi":96,"df-print":"default","error":false,"eval":true,"cache":null,"freeze":false,"echo":true,"output":true,"warning":true,"include":true,"keep-md":false,"keep-ipynb":false,"ipynb":null,"enabled":false,"daemon":null,"daemon-restart":false,"debug":false,"ipynb-filters":[],"engine":"jupyter"},"render":{"keep-tex":false,"keep-source":false,"keep-hidden":false,"prefer-html":false,"output-divs":true,"output-ext":"html","fig-align":"default","fig-pos":null,"fig-env":null,"code-fold":"none","code-overflow":"scroll","code-link":false,"code-line-numbers":false,"code-tools":false,"tbl-colwidths":"auto","merge-includes":true,"inline-includes":false,"preserve-yaml":false,"latex-auto-mk":true,"latex-auto-install":true,"latex-clean":true,"latex-max-runs":10,"latex-makeindex":"makeindex","latex-makeindex-opts":[],"latex-tlmgr-opts":[],"latex-input-paths":[],"latex-output-dir":null,"link-external-icon":false,"link-external-newwindow":false,"self-contained-math":false,"format-resources":[],"notebook-links":true,"format-links":true},"pandoc":{"standalone":true,"wrap":"none","default-image-extension":"png","to":"html","css":["styles.css"],"toc":true,"output-file":"core.html"},"language":{"toc-title-document":"Table of contents","toc-title-website":"On this page","related-formats-title":"Other Formats","related-notebooks-title":"Notebooks","source-notebooks-prefix":"Source","section-title-abstract":"Abstract","section-title-appendices":"Appendices","section-title-footnotes":"Footnotes","section-title-references":"References","section-title-reuse":"Reuse","section-title-copyright":"Copyright","section-title-citation":"Citation","appendix-attribution-cite-as":"For attribution, please cite this work as:","appendix-attribution-bibtex":"BibTeX citation:","title-block-author-single":"Author","title-block-author-plural":"Authors","title-block-affiliation-single":"Affiliation","title-block-affiliation-plural":"Affiliations","title-block-published":"Published","title-block-modified":"Modified","callout-tip-title":"Tip","callout-note-title":"Note","callout-warning-title":"Warning","callout-important-title":"Important","callout-caution-title":"Caution","code-summary":"Code","code-tools-menu-caption":"Code","code-tools-show-all-code":"Show All Code","code-tools-hide-all-code":"Hide All Code","code-tools-view-source":"View Source","code-tools-source-code":"Source Code","code-line":"Line","code-lines":"Lines","copy-button-tooltip":"Copy to Clipboard","copy-button-tooltip-success":"Copied!","repo-action-links-edit":"Edit this page","repo-action-links-source":"View source","repo-action-links-issue":"Report an issue","back-to-top":"Back to top","search-no-results-text":"No results","search-matching-documents-text":"matching documents","search-copy-link-title":"Copy link to search","search-hide-matches-text":"Hide additional matches","search-more-match-text":"more match in this document","search-more-matches-text":"more matches in this document","search-clear-button-title":"Clear","search-detached-cancel-button-title":"Cancel","search-submit-button-title":"Submit","search-label":"Search","toggle-section":"Toggle section","toggle-sidebar":"Toggle sidebar navigation","toggle-dark-mode":"Toggle dark mode","toggle-reader-mode":"Toggle reader mode","toggle-navigation":"Toggle navigation","crossref-fig-title":"Figure","crossref-tbl-title":"Table","crossref-lst-title":"Listing","crossref-thm-title":"Theorem","crossref-lem-title":"Lemma","crossref-cor-title":"Corollary","crossref-prp-title":"Proposition","crossref-cnj-title":"Conjecture","crossref-def-title":"Definition","crossref-exm-title":"Example","crossref-exr-title":"Exercise","crossref-ch-prefix":"Chapter","crossref-apx-prefix":"Appendix","crossref-sec-prefix":"Section","crossref-eq-prefix":"Equation","crossref-lof-title":"List of Figures","crossref-lot-title":"List of Tables","crossref-lol-title":"List of Listings","environment-proof-title":"Proof","environment-remark-title":"Remark","environment-solution-title":"Solution","listing-page-order-by":"Order By","listing-page-order-by-default":"Default","listing-page-order-by-date-asc":"Oldest","listing-page-order-by-date-desc":"Newest","listing-page-order-by-number-desc":"High to Low","listing-page-order-by-number-asc":"Low to High","listing-page-field-date":"Date","listing-page-field-title":"Title","listing-page-field-description":"Description","listing-page-field-author":"Author","listing-page-field-filename":"File Name","listing-page-field-filemodified":"Modified","listing-page-field-subtitle":"Subtitle","listing-page-field-readingtime":"Reading Time","listing-page-field-categories":"Categories","listing-page-minutes-compact":"{0} min","listing-page-category-all":"All","listing-page-no-matches":"No matching items"},"metadata":{"lang":"en","fig-responsive":true,"quarto-version":"1.3.450","theme":"cosmo","description":"bioMONAI core","title":"core"},"extensions":{"book":{"multiFile":true}}}},"projectFormats":["html"]}
+{"title":"core","markdown":{"yaml":{"description":"bioMONAI core","output-file":"core.html","title":"core"},"headingText":"Imports","containsRefs":false,"markdown":"\n\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n\n## Utils\n\n---\n","srcMarkdownNoYaml":"\n\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Imports\n\n## Utils\n\n---\n"},"formats":{"html":{"identifier":{"display-name":"HTML","target-format":"html","base-format":"html"},"execute":{"fig-width":7,"fig-height":5,"fig-format":"retina","fig-dpi":96,"df-print":"default","error":false,"eval":true,"cache":null,"freeze":false,"echo":true,"output":true,"warning":true,"include":true,"keep-md":false,"keep-ipynb":false,"ipynb":null,"enabled":false,"daemon":null,"daemon-restart":false,"debug":false,"ipynb-filters":[],"engine":"jupyter"},"render":{"keep-tex":false,"keep-source":false,"keep-hidden":false,"prefer-html":false,"output-divs":true,"output-ext":"html","fig-align":"default","fig-pos":null,"fig-env":null,"code-fold":"none","code-overflow":"scroll","code-link":false,"code-line-numbers":false,"code-tools":false,"tbl-colwidths":"auto","merge-includes":true,"inline-includes":false,"preserve-yaml":false,"latex-auto-mk":true,"latex-auto-install":true,"latex-clean":true,"latex-max-runs":10,"latex-makeindex":"makeindex","latex-makeindex-opts":[],"latex-tlmgr-opts":[],"latex-input-paths":[],"latex-output-dir":null,"link-external-icon":false,"link-external-newwindow":false,"self-contained-math":false,"format-resources":[],"notebook-links":true,"format-links":true},"pandoc":{"standalone":true,"wrap":"none","default-image-extension":"png","to":"html","css":["styles.css"],"toc":true,"output-file":"core.html"},"language":{"toc-title-document":"Table of contents","toc-title-website":"On this page","related-formats-title":"Other Formats","related-notebooks-title":"Notebooks","source-notebooks-prefix":"Source","section-title-abstract":"Abstract","section-title-appendices":"Appendices","section-title-footnotes":"Footnotes","section-title-references":"References","section-title-reuse":"Reuse","section-title-copyright":"Copyright","section-title-citation":"Citation","appendix-attribution-cite-as":"For attribution, please cite this work as:","appendix-attribution-bibtex":"BibTeX citation:","title-block-author-single":"Author","title-block-author-plural":"Authors","title-block-affiliation-single":"Affiliation","title-block-affiliation-plural":"Affiliations","title-block-published":"Published","title-block-modified":"Modified","callout-tip-title":"Tip","callout-note-title":"Note","callout-warning-title":"Warning","callout-important-title":"Important","callout-caution-title":"Caution","code-summary":"Code","code-tools-menu-caption":"Code","code-tools-show-all-code":"Show All Code","code-tools-hide-all-code":"Hide All Code","code-tools-view-source":"View Source","code-tools-source-code":"Source Code","code-line":"Line","code-lines":"Lines","copy-button-tooltip":"Copy to Clipboard","copy-button-tooltip-success":"Copied!","repo-action-links-edit":"Edit this page","repo-action-links-source":"View source","repo-action-links-issue":"Report an issue","back-to-top":"Back to top","search-no-results-text":"No results","search-matching-documents-text":"matching documents","search-copy-link-title":"Copy link to search","search-hide-matches-text":"Hide additional matches","search-more-match-text":"more match in this document","search-more-matches-text":"more matches in this document","search-clear-button-title":"Clear","search-detached-cancel-button-title":"Cancel","search-submit-button-title":"Submit","search-label":"Search","toggle-section":"Toggle section","toggle-sidebar":"Toggle sidebar navigation","toggle-dark-mode":"Toggle dark mode","toggle-reader-mode":"Toggle reader mode","toggle-navigation":"Toggle navigation","crossref-fig-title":"Figure","crossref-tbl-title":"Table","crossref-lst-title":"Listing","crossref-thm-title":"Theorem","crossref-lem-title":"Lemma","crossref-cor-title":"Corollary","crossref-prp-title":"Proposition","crossref-cnj-title":"Conjecture","crossref-def-title":"Definition","crossref-exm-title":"Example","crossref-exr-title":"Exercise","crossref-ch-prefix":"Chapter","crossref-apx-prefix":"Appendix","crossref-sec-prefix":"Section","crossref-eq-prefix":"Equation","crossref-lof-title":"List of Figures","crossref-lot-title":"List of Tables","crossref-lol-title":"List of Listings","environment-proof-title":"Proof","environment-remark-title":"Remark","environment-solution-title":"Solution","listing-page-order-by":"Order By","listing-page-order-by-default":"Default","listing-page-order-by-date-asc":"Oldest","listing-page-order-by-date-desc":"Newest","listing-page-order-by-number-desc":"High to Low","listing-page-order-by-number-asc":"Low to High","listing-page-field-date":"Date","listing-page-field-title":"Title","listing-page-field-description":"Description","listing-page-field-author":"Author","listing-page-field-filename":"File Name","listing-page-field-filemodified":"Modified","listing-page-field-subtitle":"Subtitle","listing-page-field-readingtime":"Reading Time","listing-page-field-categories":"Categories","listing-page-minutes-compact":"{0} min","listing-page-category-all":"All","listing-page-no-matches":"No matching items"},"metadata":{"lang":"en","fig-responsive":true,"quarto-version":"1.3.450","theme":"cosmo","description":"bioMONAI core","title":"core"},"extensions":{"book":{"multiFile":true}}}},"projectFormats":["html"]}