Skip to content

Commit 2e3fb52

Browse files
committed
deploy: 3a431fd
1 parent aec67af commit 2e3fb52

File tree

3 files changed

+36
-10
lines changed

3 files changed

+36
-10
lines changed

_sources/step_1_configuration.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,13 +121,27 @@ We suggest using this setting in conjunction with a small number of JOB_RETRIES.
121121

122122
### PLUGINS
123123
* **USE_PLUGINS:** Whether or not you will be using external plugins from the CellProfiler-plugins repository.
124+
When True, passes the `--plugins-directory` flag to CellProfiler.
125+
Defaults to the current v1.0 `CellProfiler-plugins/active_plugins` location for plugins but will revert to the historical location of plugins in the `CellProfiler-plugins` root directory if the `active_plugins` folder is not present.
124126
* **UPDATE_PLUGINS:** Whether or not to update the plugins repository before use.
125127
(i.e. run `git fetch --all` on CellProfiler-plugins)
126-
* **PLUGINS_COMMIT:** What commit or version tag to check out.
128+
* **PLUGINS_COMMIT:** If desired, what commit or version tag to check out.
127129
Used in the `git checkout PLUGINS_COMMIT` command in CellProfiler-plugins.
130+
If you do not want to checkout a specific commit, set to False.
128131
* **INSTALL_REQUIREMENTS:** Whether or not to install requirements associate with plugins.
129-
* **REQUIREMENTS_FILE:** A path within the CellProfiler-plugins repository to the requirements file you would like to install.
130-
Used in the `pip install -r REQUIREMENTS_FILE` command.
132+
Not all plugins require additional requirement installation.
133+
See [CellProfiler-plugins Documentation](https://plugins.cellprofiler.org/using_plugins.html) for more information on requirements.
134+
* **REQUIREMENTS:** For current v1.0 CellProfiler-plugins, a flag that will be passed to the install command (e.g. `cellpose`).
135+
See [CellProfiler-plugins Documentation](https://plugins.cellprofiler.org/using_plugins.html) for more information on supported flags.
136+
For deprecated versions of CellProfiler-plugins before v1.0, pass a path within the CellProfiler-plugins repository to the requirements file you would like to install that will be used in the `pip install -r REQUIREMENTS_FILE` command.
137+
138+
The [CellProfiler/Distributed-CellProfiler Docker](https://hub.docker.com/r/cellprofiler/distributed-cellprofiler/tags) 2.0.0_4.2.4 and older have a clone of the CellProfiler-plugins repository with deprecated organization in them.
139+
If you would like to continue using this clone, set `USE_PLUGINS = 'True'` and `UPDATE_PLUGINS = 'False'`.
140+
Note that if you do need to install requirements with the deprecated organization, pass the path to the requirements file within the CellProfiler-plugins repository as `REQUIREMENTS`.
141+
If you would like to update the CellProfiler-plugins repository with up-to-date plugins and new structure while using the CellProfiler/Distributed-CellProfiler Docker 2.0.0_4.2.4 and older, set `UPDATE_PLUGINS = 'True'`.
142+
143+
[CellProfiler/Distributed-CellProfiler Dockers](https://hub.docker.com/r/cellprofiler/distributed-cellprofiler/tags) newer than 2.0.0_4.2.4 have current CellProfiler-plugins repository organization.
144+
If you need to use deprecated plugin organization you can access previous commits or version tags by passing them as `PLUGINS_COMMIT`.
131145

132146
***
133147

0 commit comments

Comments
 (0)