Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme for Janelia #27

Merged
merged 6 commits into from
Dec 1, 2020
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
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,26 @@ The `kiosk-imageJ-plugin` is a ImageJ 1.x plugin for easily processing images wi
2. Open ImageJ.
3. Navigate to Plugins > Install...
4. Select the downloaded JAR file.
5. Install it into the `jars` directory.
5. Install it into the `plugins` folder.

## How to Run the plugin

1. Open an image in ImageJ.
2. Navigate to Plugins > DeepCell Kiosk > Submit Active Image.
3. Update custom options (especially the DeepCell Kiosk Host to your own Kiosk IP address).
4. Select the job type ("segmentation" is default). Please make sure your image is appropriate for the job.

![image](resources/step_1_screenshot.png)

2. Navigate to Plugins > DeepCell Kiosk > Submit Active Image.

![image](resources/step_2_screenshot.png)

3. If you're running one of our pretrained models, please make sure the settings all match the screenshot below. If you're running your own Kiosk, make sure to update the IP address for your custom instance.

![image](resources/step_3_screenshot.png)

4. Select which model you wish to run ("multiplex" is the default). Please see our [documentation](https://github.com/vanvalenlab/intro-to-deepcell/tree/master/deepcell_dot_org#formatting-data-for-web-based-models) for data requirements for the different model types.

![image](resources/step_4_screenshot.png)

5. Click OK to run the job.
6. Await your results! They should be automatically downloaded and opened.

Expand Down
Binary file added resources/step_1_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/step_2_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/step_3_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/step_4_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.