Skip to content

Commit 827a3ca

Browse files
committed
change readme/intro
1 parent 6c24b54 commit 827a3ca

2 files changed

Lines changed: 18 additions & 44 deletions

File tree

README.md

Lines changed: 11 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,14 @@
1-
CellProfiler-plugins
2-
====================
3-
[![Build Status](https://travis-ci.org/CellProfiler/CellProfiler-plugins.svg?branch=master)](https://travis-ci.org/CellProfiler/CellProfiler-plugins)
1+
# CellProfiler-plugins
42

5-
A home for community-contributed and experimental CellProfiler modules.
3+
A home for community-contributed, experimental, and dependency-heavy CellProfiler modules.
64

7-
## Beginner-level instructions
8-
[Beginner guidance for using plugins in CellProfiler](https://github.com/CellProfiler/CellProfiler/blob/master/cellprofiler/data/help/other_plugins.rst)
5+
Plugins advance the capabilities of CellProfiler but are not officially supported in the same way as modules.
6+
A module may be in CellProfiler-plugins instead of CellProfiler itself because:
7+
- it is under active development
8+
- it has a niche audience
9+
- it is not documented to CellProfiler's standards
10+
- it only works with certain version of CellProfiler
11+
- it requires extra libraries or other dependencies we are unable or unwilling to require for CellProfiler
12+
- it has been contributed by a community member
913

10-
Beginner instructions for installing runCellpose, runStarDist, and all other plugins with CellProfiler from source:
11-
* [Windows](https://github.com/CellProfiler/CellProfiler-plugins/blob/master/Instructions/Install_environment_instructions_windows.md)
12-
* [Mac_Intel_version](https://github.com/CellProfiler/CellProfiler-plugins/blob/master/Instructions/Install_environment_instructions_mac.pdf)
13-
14-
15-
## Use
16-
1. Clone this repository into a folder (PLUGIN_DIRECTORY) on your local computer:
17-
```
18-
cd PLUGIN_DIRECTORY
19-
git clone https://github.com/CellProfiler/CellProfiler-plugins.git
20-
```
21-
22-
Alternatively download zip and manually extract to PLUGIN_DIRECTORY.
23-
24-
1. Install required dependencies:
25-
```
26-
cd CellProfiler-plugins
27-
pip install -r requirements.txt
28-
```
29-
30-
To install CellProfiler-plugins on a windows machine with support for the deep learning module ClassifyPixels-UNet make sure you have [Visual Studio](https://support.microsoft.com/help/2977003/the-latest-supported-visual-c-downloads) 2017 installed then use
31-
```
32-
cd CellProfiler-plugins
33-
pip install -r requirements-windows.txt
34-
```
35-
36-
1. Configure CellProfiler plugins directory in the GUI via `Preferences > CellProfiler plugins directory` (you will need to restart CellProfiler for the change to take effect). When running CellProfiler via the command line, use the `--plugins-directory` flag to specify the plugins directory, for example:
37-
```
38-
cellprofiler --run --run-headless --project PROJECT_FILE --plugins-directory PLUGIN_DIRECTORY/CellProfiler-plugins
39-
```
40-
41-
## ImageJ requirements
42-
43-
If using the `RunImageJScript` module, please note:
44-
* You will also need to [install Maven](https://github.com/imagej/pyimagej/blob/master/doc/Install.md#installing-via-pip)
45-
* CellProfiler will need to be [built from source](https://github.com/CellProfiler/CellProfiler/blob/master/cellprofiler/data/help/other_plugins.rst) due to the requirement of additional libraries
14+
Please see our [CellProfiler-plugins documentation](https://cellprofiler.github.io/CellProfiler-plugins) for more information about installation, currently supported plugins, and how to contribute.

documentation/CP-plugins-documentation/overview.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
# What are CellProfiler Plugins?
22

33
Plugins advance the capabilities of CellProfiler but are not officially supported in the same way as modules.
4-
Plugins can bring in bridges to other software (like ImageJ, ilastik, Cellpose, and StarDist)
5-
Because of this, it is necessary to install CellProfiler from source so it can interact correctly with other software
4+
A module may be in CellProfiler-plugins instead of CellProfiler itself because:
5+
- it is under active development
6+
- it has a niche audience
7+
- it is not documented to CellProfiler's standards
8+
- it only works with certain version of CellProfiler
9+
- it requires extra libraries or other dependencies we are unable or unwilling to require for CellProfiler
10+
- it has been contributed by a community member
611

712

813
## Who made this?

0 commit comments

Comments
 (0)