Skip to content

Commit ab54863

Browse files
Doc updates (#211)
* Update _config.yml * Add issue for zsh in macs * Update _toc.yml * runcellpose capitalization --------- Co-authored-by: Erin Weisbart <54687786+ErinWeisbart@users.noreply.github.com>
1 parent dbba620 commit ab54863

4 files changed

Lines changed: 11 additions & 5 deletions

File tree

documentation/CP-plugins-documentation/_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ execute:
1717
# Information about where the book exists on the web
1818
repository:
1919
url: https://github.com/cellprofiler/cellprofiler-plugins
20-
branch: main # Which branch of the repository should be used when creating links (optional)
21-
path_to_book: CP-plugins-documentation
20+
branch: master # Which branch of the repository should be used when creating links (optional)
21+
path_to_book: documentation/CP-plugins-documentation
2222

2323
html:
2424
baseurl: cellprofiler.github.io

documentation/CP-plugins-documentation/_toc.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ parts:
66
- caption: Overview
77
chapters:
88
- file: using_plugins
9-
sections:
10-
- file: RunCellpose
119
- file: supported_plugins
1210
- file: unsupported_plugins
1311
- file: contributing_plugins
1412
- file: troubleshooting
1513
- file: citing
1614
- file: versions
15+
16+
- caption: Extra information about specific plugins
17+
chapters:
18+
- file: runcellpose
File renamed without changes.

documentation/CP-plugins-documentation/using_plugins.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@ pip install -e .[FLAG]
7575
```
7676
e.g. To install Cellpose the pip install command would be `pip install -e .[cellpose]`
7777

78+
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]'`
79+
7880
5. **Open and use CellProfiler.**
7981

8082
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:
163165
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.
164166
This information is not available in Mac machines.
165167

168+
166169
### Using Docker to bypass installation requirements
167170

168171
1. **Download Docker**
@@ -175,4 +178,5 @@ Docker Desktop will need to be open every time you use a plugin with Docker.
175178
3. **Select "Run with Docker"**
176179
In your plugin, select `Docker` for "Run module in docker or local python environment" setting.
177180
On the first run of the plugin, the Docker container will be downloaded, however, this slow downloading process will only have to happen
178-
once.
181+
once.
182+

0 commit comments

Comments
 (0)