https://github.com/imagej/example-script-collection

Example project demonstrating how to package ImageJ scripts into a single jar file
https://github.com/imagej/example-script-collection

Last synced: 9 months ago
JSON representation

Example project demonstrating how to package ImageJ scripts into a single jar file

• Host: GitHub
• URL: https://github.com/imagej/example-script-collection
• Owner: imagej
• Created: 2017-10-25T07:25:30.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2022-04-11T20:40:20.000Z (about 4 years ago)
• Last Synced: 2025-04-19T02:23:15.666Z (about 1 year ago)
• Language: Java
• Homepage:
• Size: 25.4 KB
• Stars: 10
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Example script collection for ImageJ

[![CI Build](https://github.com/imagej/example-script-collection/actions/workflows/build-main.yml/badge.svg)](https://github.com/imagej/example-script-collection/actions/workflows/build-main.yml)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/facf0eb976f44461af81d4469d597c0d)](https://www.codacy.com/app/imagejan/example-script-collection?utm_source=github.com&utm_medium=referral&utm_content=imagej/example-script-collection&utm_campaign=Badge_Grade)

This repository illustrates how to manage several ImageJ scripts in a

collection.

---

Note that to make scripts available as menu commands in ImageJ, it is

sufficient to put the script files into a _subfolder_ of `ImageJ.app/scripts/`,

and to make them available to others, it is sufficient to upload the script

files to an update site.

---

Keeping script files in a collection like this one adds the following benefits:

* *Dependency* management with Maven

* *Versioned* deployment using Git, Maven, and GitHub Actions

* Optionally: keep your scripts functional by running *Java unit tests* with every build

## How to use

1. Visit [this link](https://github.com/imagej/example-script-collection/generate)

   to create a new repository in your space using this one as a template.

2. Delete `src/test/java` if you don't require tests.

3. Put your scripts into a *subfolder* of `src/main/resources/scripts` (the

   name of the subfolder[s] corresponds to the menu[s] where the commands will

   appear).

4. Edit `pom.xml` to reflect your project information.

5. Run `mvn` to build your jar file, or

   `mvn -Dscijava.app.directory=/path/to/your/ImageJ.app` to directly copy the

   jar file and possible dependencies into your ImageJ/Fiji installation.

5. Make your initial

   [commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project) and

   [push the results](https://help.github.com/en/articles/pushing-commits-to-a-remote-repository)!

## Questions

Please ask on the [Image.sc Forum](https://forum.image.sc/tag/imagej).