diff --git a/documentation/CP-plugins-documentation/_config.yml b/documentation/CP-plugins-documentation/_config.yml index 702fc3aa..1c0723e5 100644 --- a/documentation/CP-plugins-documentation/_config.yml +++ b/documentation/CP-plugins-documentation/_config.yml @@ -17,8 +17,8 @@ execute: # Information about where the book exists on the web repository: url: https://github.com/cellprofiler/cellprofiler-plugins - branch: main # Which branch of the repository should be used when creating links (optional) - path_to_book: CP-plugins-documentation + branch: master # Which branch of the repository should be used when creating links (optional) + path_to_book: documentation/CP-plugins-documentation html: baseurl: cellprofiler.github.io diff --git a/documentation/CP-plugins-documentation/_toc.yml b/documentation/CP-plugins-documentation/_toc.yml index 9c508c45..130d6329 100644 --- a/documentation/CP-plugins-documentation/_toc.yml +++ b/documentation/CP-plugins-documentation/_toc.yml @@ -6,11 +6,13 @@ parts: - caption: Overview chapters: - file: using_plugins - sections: - - file: RunCellpose - file: supported_plugins - file: unsupported_plugins - file: contributing_plugins - file: troubleshooting - file: citing - file: versions + +- caption: Extra information about specific plugins + chapters: + - file: runcellpose diff --git a/documentation/CP-plugins-documentation/RunCellPose.md b/documentation/CP-plugins-documentation/runcellpose.md similarity index 100% rename from documentation/CP-plugins-documentation/RunCellPose.md rename to documentation/CP-plugins-documentation/runcellpose.md diff --git a/documentation/CP-plugins-documentation/using_plugins.md b/documentation/CP-plugins-documentation/using_plugins.md index d2fbfa68..d823ec52 100644 --- a/documentation/CP-plugins-documentation/using_plugins.md +++ b/documentation/CP-plugins-documentation/using_plugins.md @@ -75,6 +75,8 @@ pip install -e .[FLAG] ``` e.g. To install Cellpose the pip install command would be `pip install -e .[cellpose]` +If using Mac and getting an error saying `zsh: no matches found: .[somepackage]`, put the dot and square brackets in single quotes, ie `pip install -e '.[cellpose]'` + 5. **Open and use CellProfiler.** Please note that plugins that have separate install flags may have conflicting dependencies so we recommend making a separate python environment in which to run separate installations. @@ -163,6 +165,7 @@ These are all the folders you need to copy over: When you try to run your plugin in your pipeline, if you have missed copying over any specific requirements, it will give you an error message that will tell you what dependency is missing in the terminal window that opens with CellProfiler on Windows machines. This information is not available in Mac machines. + ### Using Docker to bypass installation requirements 1. **Download Docker** @@ -175,4 +178,5 @@ Docker Desktop will need to be open every time you use a plugin with Docker. 3. **Select "Run with Docker"** In your plugin, select `Docker` for "Run module in docker or local python environment" setting. On the first run of the plugin, the Docker container will be downloaded, however, this slow downloading process will only have to happen -once. \ No newline at end of file +once. +