Merge branch 'main' into mwmw/docs-welcomeRST

Author: C-Achard

.gitignore

@@ -91,5 +91,5 @@ venv/
 ########
 #project specific
 #dataset
-/src/napari_cellseg_3d/models/dataset/
-/src/napari_cellseg_3d/models/saved_weights/
+/src/napari_cellseg3d/models/dataset/
+/src/napari_cellseg3d/models/saved_weights/

README.md

@@ -1,11 +1,11 @@
-# napari-cellseg-3d
+# napari-cellseg3d
 
-[![License](https://img.shields.io/pypi/l/napari-cellseg-3d.svg?color=green)](https://github.com/C_Achard/napari-cellseg-3d/raw/main/LICENSE)
-[![PyPI](https://img.shields.io/pypi/v/napari-cellseg-3d.svg?color=green)](https://pypi.org/project/napari-cellseg-3d)
-[![Python Version](https://img.shields.io/pypi/pyversions/napari-cellseg-3d.svg?color=green)](https://python.org)
-[![tests](https://github.com/C_Achard/napari-cellseg-3d/workflows/tests/badge.svg)](https://github.com/C_Achard/napari-cellseg-3d/actions)
-[![codecov](https://codecov.io/gh/C_Achard/napari-cellseg-3d/branch/main/graph/badge.svg)](https://codecov.io/gh/C_Achard/napari-cellseg-3d)
-[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-cellseg-3d)](https://napari-hub.org/plugins/napari-cellseg-3d)
+[![License](https://img.shields.io/pypi/l/napari-cellseg3d.svg?color=green)](https://github.com/C_Achard/napari-cellseg3d/raw/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/napari-cellseg3d.svg?color=green)](https://pypi.org/project/napari-cellseg3d)
+[![Python Version](https://img.shields.io/pypi/pyversions/napari-cellseg3d.svg?color=green)](https://python.org)
+[![tests](https://github.com/C_Achard/napari-cellseg3d/workflows/tests/badge.svg)](https://github.com/C_Achard/napari-cellseg3d/actions)
+[![codecov](https://codecov.io/gh/C_Achard/napari-cellseg3d/branch/main/graph/badge.svg)](https://codecov.io/gh/C_Achard/napari-cellseg3d)
+[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-cellseg3d)](https://napari-hub.org/plugins/napari-cellseg3d)
 
 plugin for cell segmentation
 
@@ -32,9 +32,9 @@ If you get errors from MONAI regarding missing readers, please see [MONAI's opti
 
 ## Installation
 
-You can install `napari-cellseg-3d` via [pip]:
+You can install `napari-cellseg3d` via [pip]:
 
-    pip install napari-cellseg-3d
+    pip install napari-cellseg3d
 
 For local installation, please run:
 
@@ -52,7 +52,7 @@ To use the plugin, please run:
 ```
 napari
 ```
-Then go into Plugins > napari-cellseg-3d, and choose which tool to use.
+Then go into Plugins > napari-cellseg3d, and choose which tool to use.
 
 - **Review**: This module allows you to review your labels, from predictions or manual labeling, and correct them if needed. It then saves the status of each file in a csv, for easier monitoring.
 - **Infer**: This module allows you to use pre-trained segmentation algorithms on volumes to automatically label cells.
@@ -75,7 +75,7 @@ the coverage at least stays the same before you submit a pull request.
 ## License
 
 Distributed under the terms of the [MIT] license,
-"napari-cellseg-3d" is free and open source software
+"napari-cellseg3d" is free and open source software
 
 ## Issues
 

docs/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# napari-cellseg-3d documentation build configuration file, created by
+# napari-cellseg3d documentation build configuration file, created by
 # sphinx-quickstart on Thu Oct  1 00:43:18 2015.
 #
 # This file is execfile()d with the current directory set to its
@@ -51,7 +51,7 @@
 main_doc = "index"
 
 # General information about the project.
-project = "napari-cellseg-3d"
+project = "napari-cellseg3d"
 copyright = "2022, Cyril Achard, Maxime Vidal"
 author = "Cyril Achard, Maxime Vidal"
 
@@ -266,7 +266,7 @@
     (
         main_doc,
         "napari-cookiecutterplugin_name",
-        "napari-cellseg-3d Documentation",
+        "napari-cellseg3d Documentation",
         [author],
         1,
     )
@@ -285,7 +285,7 @@
     (
         main_doc,
         "napari-cookiecutterplugin_name",
-        "napari-cellseg-3d Documentation",
+        "napari-cellseg3d Documentation",
         author,
         "napari-cookiecutterplugin_name",
         "One line description of project.",

docs/index.rst

@@ -1,4 +1,4 @@
-Welcome to napari-cellseg-3d's documentation!
+Welcome to napari-cellseg3d's documentation!
 ===============================================================
 
 .. toctree::

docs/res/code/interface.rst

@@ -6,50 +6,50 @@ Functions
 
 open_url
 **************************************
-.. autofunction:: napari_cellseg_3d.interface::open_url
+.. autofunction:: napari_cellseg3d.interface::open_url
 
 
 make_scrollable
 **************************************
-.. autofunction:: napari_cellseg_3d.interface::make_scrollable
+.. autofunction:: napari_cellseg3d.interface::make_scrollable
 
 
 make_group
 **************************************
-.. autofunction:: napari_cellseg_3d.interface::make_group
+.. autofunction:: napari_cellseg3d.interface::make_group
 
 
 make_container_widget
 **************************************
-.. autofunction:: napari_cellseg_3d.interface::make_container_widget
+.. autofunction:: napari_cellseg3d.interface::make_container_widget
 
 
 make_button
 **************************************
-.. autofunction:: napari_cellseg_3d.interface::make_button
+.. autofunction:: napari_cellseg3d.interface::make_button
 
 make_combobox
 **************************************
-.. autofunction:: napari_cellseg_3d.interface::make_combobox
+.. autofunction:: napari_cellseg3d.interface::make_combobox
 
 make_checkbox
 **************************************
-.. autofunction:: napari_cellseg_3d.interface::make_checkbox
+.. autofunction:: napari_cellseg3d.interface::make_checkbox
 
 
 combine_blocks
 **************************************
-.. autofunction:: napari_cellseg_3d.interface::combine_blocks
+.. autofunction:: napari_cellseg3d.interface::combine_blocks
 
 
 add_blank
 **************************************
-.. autofunction:: napari_cellseg_3d.interface::add_blank
+.. autofunction:: napari_cellseg3d.interface::add_blank
 
 
 open_file_dialog
 **************************************
-.. autofunction:: napari_cellseg_3d.interface::open_file_dialog
+.. autofunction:: napari_cellseg3d.interface::open_file_dialog
 
 
 

docs/res/code/launch_review.rst

@@ -7,4 +7,4 @@ Functions
 launch_review
 *******************************
 
-.. autofunction:: napari_cellseg_3d.launch_review::launch_review
+.. autofunction:: napari_cellseg3d.launch_review::launch_review

docs/res/code/model_framework.rst

@@ -11,13 +11,13 @@ Class : ModelFramework
 
 Methods
 **********************
-.. autoclass:: napari_cellseg_3d.model_framework::ModelFramework
+.. autoclass:: napari_cellseg3d.model_framework::ModelFramework
    :members:  __init__,load_dataset_paths,save_log,get_model, get_loss,display_status_report,load_dataset_paths,create_train_dataset_dict, load_image_dataset, load_label_dataset,load_results_path,load_model_path,get_device, update_default, remove_from_viewer
    :noindex:
 
 
 Attributes
 *********************
 
-.. autoclass:: napari_cellseg_3d.model_framework::ModelFramework
+.. autoclass:: napari_cellseg3d.model_framework::ModelFramework
    :members:  _viewer, worker, docked_widgets, images_filepaths, labels_filepaths, results_path, model_path

docs/res/code/model_instance_seg.rst

@@ -7,20 +7,20 @@ Functions
 
 binary_connected
 **************************************
-.. autofunction:: napari_cellseg_3d.model_instance_seg::binary_connected
+.. autofunction:: napari_cellseg3d.model_instance_seg::binary_connected
 
 binary_watershed
 **************************************
-.. autofunction:: napari_cellseg_3d.model_instance_seg::binary_watershed
+.. autofunction:: napari_cellseg3d.model_instance_seg::binary_watershed
 
 clear_small_objects
 **************************************
-.. autofunction:: napari_cellseg_3d.model_instance_seg::clear_small_objects
+.. autofunction:: napari_cellseg3d.model_instance_seg::clear_small_objects
 
 to_instance
 **************************************
-.. autofunction:: napari_cellseg_3d.model_instance_seg::to_instance
+.. autofunction:: napari_cellseg3d.model_instance_seg::to_instance
 
 to_semantic
 **************************************
-.. autofunction:: napari_cellseg_3d.model_instance_seg::to_semantic
+.. autofunction:: napari_cellseg3d.model_instance_seg::to_semantic

docs/res/code/model_workers.rst

@@ -10,7 +10,7 @@ Class : LogSignal
 
 Attributes
 ************************
-.. autoclass:: napari_cellseg_3d.model_workers::LogSignal
+.. autoclass:: napari_cellseg3d.model_workers::LogSignal
    :members: log_signal
    :noindex:
 
@@ -24,7 +24,7 @@ Class : InferenceWorker
 
 Methods
 ************************
-.. autoclass:: napari_cellseg_3d.model_workers::InferenceWorker
+.. autoclass:: napari_cellseg3d.model_workers::InferenceWorker
    :members: __init__, log, create_inference_dict, inference
    :noindex:
 
@@ -39,7 +39,7 @@ Class : TrainingWorker
 
 Methods
 ************************
-.. autoclass:: napari_cellseg_3d.model_workers::TrainingWorker
+.. autoclass:: napari_cellseg3d.model_workers::TrainingWorker
    :members: __init__, log, train
    :noindex:
 

docs/res/code/plugin_base.rst

@@ -8,7 +8,7 @@ Class : BasePluginSingleImage
 
 Methods
 **********************
-.. autoclass:: napari_cellseg_3d.plugin_base::BasePluginSingleImage
+.. autoclass:: napari_cellseg3d.plugin_base::BasePluginSingleImage
    :members:  __init__, remove_from_viewer, show_dialog_images, show_dialog_labels, update_default
    :noindex:
 
@@ -17,7 +17,7 @@ Methods
 Attributes
 *********************
 
-.. autoclass:: napari_cellseg_3d.plugin_base::BasePluginSingleImage
+.. autoclass:: napari_cellseg3d.plugin_base::BasePluginSingleImage
    :members:  _viewer, image_path, label_path, filetype, file_handling_box
 
 
@@ -29,13 +29,13 @@ Class : BasePluginFolder
 
 Methods
 ***********************
-.. autoclass:: napari_cellseg_3d.plugin_base::BasePluginFolder
+.. autoclass:: napari_cellseg3d.plugin_base::BasePluginFolder
    :members:  __init__, remove_from_viewer,make_close_button,make_prev_button,make_next_button, load_dataset_paths,load_image_dataset,load_label_dataset,load_results_path, update_default,remove_docked_widgets
    :noindex:
 
 
 Attributes
 *********************
 
-.. autoclass:: napari_cellseg_3d.plugin_base::BasePluginFolder
+.. autoclass:: napari_cellseg3d.plugin_base::BasePluginFolder
    :members:  _viewer, images_filepaths, labels_filepaths,results_path, filetype_choice