Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions documentation/CP-plugins-documentation/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 4 additions & 2 deletions documentation/CP-plugins-documentation/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 5 additions & 1 deletion documentation/CP-plugins-documentation/using_plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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**
Expand All @@ -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.
once.