diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d5fda5f..f4e5e39 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,13 +1,7 @@ -# .readthedocs.yaml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required version: 2 -# Set the version of Python and other tools you might need build: - os: ubuntu-22.04 + os: "ubuntu-22.04" tools: python: "3.10" jobs: @@ -15,18 +9,12 @@ build: # Install poetry # https://python-poetry.org/docs/#installing-manually - pip install poetry - # Tell poetry to not use a virtual environment - - poetry config virtualenvs.create false post_install: # Install dependencies with 'docs' dependency group # https://python-poetry.org/docs/managing-dependencies/#dependency-groups - - poetry install --with docs + # VIRTUAL_ENV needs to be set manually for now. + # See https://github.com/readthedocs/readthedocs.org/pull/11152/ + - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs -# Build documentation in the docs/ directory with Sphinx sphinx: - configuration: docs/source/conf.py -# If using Sphinx, optionally build your docs in additional formats such as PDF -# formats: -# - pdf - -# Optionally declare the Python requirements required to build your docs + configuration: docs/source/conf.py \ No newline at end of file diff --git a/README.md b/README.md index 504c278..8f6043c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ +[![PyPI version preprocessing](https://badge.fury.io/py/eReg.svg)](https://pypi.python.org/pypi/eReg/) +[![Documentation Status](https://readthedocs.org/projects/ereg/badge/?version=latest)](http://ereg.readthedocs.io/?badge=latest) +[![tests](https://github.com/BrainLesion/eReg/actions/workflows/tests.yml/badge.svg)](https://github.com/BrainLesion/eReg/actions/workflows/tests.yml) + # eReg - A Simple Registration Tool +**eReg** is a robust, fast and user-friendly registration tool that can be used in clinical environments without the need for virtualization or containerization technologies. It supports most platforms across various hardware configurations. ## Need - Because of security concerns, users in clinical environments do not have access to virtualization and containerization technologies such as Docker and Singularity. This becomes a problem, because most research code (especially for image registration) is built around the need to have access to these technologies. Alternatively, some tools only work on a Linux environment, or they need specific hardware resources (such as a DL accelerator card), which are not always available in clinical settings. -**eReg** is a simple registration tool that can be used in clinical environments without the need for virtualization or containerization technologies. It supports most platforms across various hardware configurations. + ## Installation @@ -56,7 +60,7 @@ options: ``` ### Pythonic Interface -The `ereg` package provides two Python interfaces, an object-oriented interface, as well as convenience functions. +The `ereg` package provides two Python interfaces, an object-oriented interface, as well as convenience functions. A [Jupyter notebook tutorial](https://github.com/BrainLesion/tutorials/tree/main/eReg) is available to illustrate usage of the Python API. #### Object-Oriented Interface diff --git a/docs/source/conf.py b/docs/source/conf.py index b9f607c..d7f3f2f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- -project = "panoptica" +project = "eReg" copyright = "2023, florian kofler et al." author = "Florian Kofler et al." @@ -61,6 +61,6 @@ autodoc_default_options = { "members": True, "undoc-members": True, - "private-members": True, + "private-members": False, "show-inheritance": True, } diff --git a/docs/source/ereg.rst b/docs/source/ereg.rst new file mode 100644 index 0000000..66b497f --- /dev/null +++ b/docs/source/ereg.rst @@ -0,0 +1,14 @@ +eReg +====================== + + +ereg.registration +-------------------------------------------- + +.. automodule:: ereg.registration + + +ereg.functional +-------------------------------------------- + +.. automodule:: ereg.functional \ No newline at end of file diff --git a/docs/source/ereg.utils.rst b/docs/source/ereg.utils.rst new file mode 100644 index 0000000..90a8ce9 --- /dev/null +++ b/docs/source/ereg.utils.rst @@ -0,0 +1,14 @@ +eReg utils +====================== + + +ereg.metrics +-------------------------------------------- + +.. automodule:: ereg.utils.metrics + + +ereg.io +-------------------------------------------- + +.. automodule:: ereg.utils.io diff --git a/docs/source/index.rst b/docs/source/index.rst index c930f15..f789b68 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,9 +1,5 @@ -.. panoptica documentation master file, created by - sphinx-quickstart on Tue Nov 21 12:02:41 2023. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. -Welcome to panoptica's documentation! +Welcome to eReg's documentation! ===================================== .. include:: ../../README.md @@ -24,22 +20,13 @@ Indices and tables .. toctree:: :maxdepth: 2 - :caption: Panoptica: - - panoptica.rst - - - -.. toctree:: - :maxdepth: 2 - :caption: Metrics: - - panoptica.metrics.rst + :caption: eReg: + ereg.rst .. toctree:: :maxdepth: 2 :caption: Utils: - panoptica.utils.rst \ No newline at end of file + ereg.utils.rst \ No newline at end of file diff --git a/docs/source/panoptica.metrics.rst b/docs/source/panoptica.metrics.rst deleted file mode 100644 index 159d1bb..0000000 --- a/docs/source/panoptica.metrics.rst +++ /dev/null @@ -1,22 +0,0 @@ -panoptica.utils -=========================== - - -panoptica.metrics.assd --------------------------------------------- - -.. automodule:: panoptica.metrics.assd - - -panoptica.metrics.dice --------------------------------------- - -.. automodule:: panoptica.metrics.dice - - - -panoptica.metrics.iou --------------------------------------- - -.. automodule:: panoptica.metrics.iou - diff --git a/docs/source/panoptica.rst b/docs/source/panoptica.rst deleted file mode 100644 index 68da618..0000000 --- a/docs/source/panoptica.rst +++ /dev/null @@ -1,32 +0,0 @@ -panoptica -====================== - - -panoptica.evaluator --------------------------------------------- - -.. automodule:: panoptica.evaluator - - -panoptica.instance_approximator --------------------------------------------- - -.. automodule:: panoptica.instance_approximator - - -panoptica.instance_matcher --------------------------------------------- - -.. automodule:: panoptica.instance_matcher - - -panoptica.instance_evaluator --------------------------------------------- - -.. automodule:: panoptica.instance_evaluator - - -panoptica.result --------------------------------------------- - -.. automodule:: panoptica.result diff --git a/docs/source/panoptica.utils.rst b/docs/source/panoptica.utils.rst deleted file mode 100644 index 1b3056e..0000000 --- a/docs/source/panoptica.utils.rst +++ /dev/null @@ -1,23 +0,0 @@ -panoptica.utils -=========================== - - -panoptica.utils.constants --------------------------------------------- - -.. automodule:: panoptica.utils.constants - - - -panoptica.utils.datatypes --------------------------------------- - -.. automodule:: panoptica.utils.datatypes - - - -panoptica.util.numpy_utils ------------------------------------ - -.. automodule:: panoptica.utils.numpy_utils - diff --git a/pyproject.toml b/pyproject.toml index fb21e13..122193a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,11 +37,11 @@ pytest-mock = "^3.6.0" register = "ereg.cli.run:main" ereg = "ereg.cli.run:main" -# [tool.poetry.group.docs] -# optional = true - -# [tool.poetry.group.docs.dependencies] -# Sphinx = ">=7.0.0" -# sphinx-copybutton = ">=0.5.2" -# sphinx-rtd-theme = ">=1.3.0" -# myst-parser = ">=2.0.0" +[tool.poetry.group.docs] +optional = true + +[tool.poetry.group.docs.dependencies] +Sphinx = ">=7.0.0" +sphinx-copybutton = ">=0.5.2" +sphinx-rtd-theme = ">=1.3.0" +myst-parser = ">=2.0.0"