diff --git a/docs_source/source/mirp.settings.rst b/docs_source/source/configuration.rst similarity index 100% rename from docs_source/source/mirp.settings.rst rename to docs_source/source/configuration.rst diff --git a/docs_source/source/mirp.deepLearningPreprocessing.rst b/docs_source/source/deep_learning.rst similarity index 100% rename from docs_source/source/mirp.deepLearningPreprocessing.rst rename to docs_source/source/deep_learning.rst diff --git a/docs_source/source/mirp.importData.rst b/docs_source/source/image_mask_import.rst similarity index 100% rename from docs_source/source/mirp.importData.rst rename to docs_source/source/image_mask_import.rst diff --git a/docs_source/source/mirp.extractImageParameters.rst b/docs_source/source/image_metadata.rst similarity index 100% rename from docs_source/source/mirp.extractImageParameters.rst rename to docs_source/source/image_metadata.rst diff --git a/docs_source/source/index.rst b/docs_source/source/index.rst index 94f1ab3b..b008a698 100644 --- a/docs_source/source/index.rst +++ b/docs_source/source/index.rst @@ -5,12 +5,14 @@ Welcome to MIRP :maxdepth: 1 :caption: Contents: - mirp.importData - mirp.settings - mirp.extractImageParameters - mirp.extractMaskLabels - mirp.deepLearningPreprocessing - mirp.extractFeaturesAndImages + installation + quick_start + image_mask_import + configuration + image_metadata + mask_labels + deep_learning + quantitative_image_analysis Quick-start =========== @@ -28,11 +30,3 @@ MIRP is available from PyPI and can be installed using ``pip``, or other install - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs_source/source/installation.rst b/docs_source/source/installation.rst new file mode 100644 index 00000000..48ae02e8 --- /dev/null +++ b/docs_source/source/installation.rst @@ -0,0 +1,12 @@ +Installing MIRP +=============== +MIRP is available from `PyPI `_ and can be installed using ``pip``, or other installer +tools: + +.. code-block:: console + + pip install mirp + +.. note:: + We highly recommend installing MIRP in a virtual environment to avoid dependency issues. For more information + see this `primer `_. \ No newline at end of file diff --git a/docs_source/source/mirp.extractMaskLabels.rst b/docs_source/source/mask_labels.rst similarity index 100% rename from docs_source/source/mirp.extractMaskLabels.rst rename to docs_source/source/mask_labels.rst diff --git a/docs_source/source/mirp.extractFeaturesAndImages.rst b/docs_source/source/quantitative_image_analysis.rst similarity index 100% rename from docs_source/source/mirp.extractFeaturesAndImages.rst rename to docs_source/source/quantitative_image_analysis.rst diff --git a/docs_source/source/quick_start.rst b/docs_source/source/quick_start.rst new file mode 100644 index 00000000..0364d3e6 --- /dev/null +++ b/docs_source/source/quick_start.rst @@ -0,0 +1,5 @@ +Quick-start +=========== + +Before you begin, you need to: + 1. Install MIRP (see :ref:`installation`). \ No newline at end of file