Difference between revisions of "Developing Fiji"
(→The Fiji launcher: update to reflect the current state)
(→Building Fiji: update to the current state of affairs)
|Line 37:||Line 37:|
== Building Fiji ==
== Building Fiji ==
Fiji is organized into a set of [[Maven]] projects. For convenience and speed,
Fiji is organized into a set of [[Maven]] projects. For convenience and speed, []'minimal Maven-lookalike [[MiniMaven]] to build Fiji, to ,
See the [[Supported Compilers]] page for more .
See the [[Supported Compilers]] page for more
== Adding plugins ==
== Adding plugins ==
Revision as of 03:56, 2 December 2014Template:Development
Fiji is a community effort. So we are happy whenever we see new people developing Fiji!
- 1 Purpose
- 2 Getting started
- 3 The ImageJ launcher
- 4 Building Fiji
- 5 Adding plugins
- 6 Writing plugins
- 7 Adding submodules
- 8 Testing
- 9 Discussing code
- 10 Contributing
- 11 Providing documentation
- 12 Further reading for developers
The purpose of this tutorial is to get you started hacking on Fiji's source code (i.e., the core Fiji plugins). If you need to develop a new plugin for ImageJ, you do not actually need Fiji's source. Rather, see these resources:
- minimal-ij1-plugin project template
- Introduction into Developing Plugins tutorial
- Developing ImageJ 1.x plugins with NetBeans screencast
See also Developing Fiji in Eclipse for a tutorial specific to the Eclipse IDE.
The ImageJ launcher
There is a program called "ImageJ-win32.exe", "ImageJ-linux64" or similar in Fiji's root directory. Its main purpose is to load a Java virtual machine with known-good options, and then launch ImageJ.
However, it is much more powerful than that. Amongst other things, you can
- Open images: ./ImageJ-<platform> example.jpg
- Call the Jython interpreter: ./ImageJ-<platform> --jython (the classpath will be the same as when calling ImageJA), and likewise --jruby, --bsh and --js for the respective language's command-line interpreters
- Run Fiji with the system Java instead of its own one: ./ImageJ-<platform> --system. But beware: this might fail since some plugins need at least Java 1.5, and the 3D viewer needs Java3D.
- Show the java command line instead of running Fiji: ./ImageJ-<platform> --dry-run
- Compile a Java class: ./ImageJ-<platform> --javac example.java
- Run a Java class' main() method: ./ImageJ-<platform> --main-class=example
- Pass some Java options: ./ImageJ-<platform> -server -- (everything that comes before a -- is interpreted as Java option)
- Add . to the classpath and execute the given class' main() method: ./ImageJ-<platform> Example.class
- Link Fiji into the PATH: ln -s $(pwd)/ImageJ-<platform> $HOME/bin/fiji && fiji
- Start Fiji and run a menu entry directly: ./ImageJ-<platform> --run System_Clipboard (the underscore was used in place of a space to avoid having to quote the argument)
The ImageJ launcher can do more, just call ./ImageJ-<platform> --help for a short description.
Fiji is organized into a set of Maven projects. For convenience and speed, there is SciJava's minimal Maven-lookalike MiniMaven to build Fiji, but it is recommended to use an Integrated Development Environment, or at least real Maven.
After you built Fiji successfully, you can add your own plugins.
- If you haven't done so, pick a name for your .jar file, say My_Plugin. Make sure that it has at least one underscore in it, otherwise ImageJ will not pick it up. If you cannot think of a name with an underscore, just append one. Then create a subdirectory src-plugins/My_Plugin.
- Now put your sources into that subdirectory. Please no .class files. Readme or license files are okay, however.
- Create a staged-plugins/My_Plugin.config file. This will be included in the .jar file as plugins.config.
- In Fiji's root folder, call ./fiji bin/commit-plugin.py src-plugins/My_Plugin/. Please make sure that it ends with a slash. This command will make the necessary edits to the pom.xml and .gitignore files, and staged-plugins/My_Plugin.config, and commit everything needed for your plugin. If you want to do this manually, look in the Git log for an example (e.g. TurboReg) and imitate it.
- Now build the plugin with ./fiji --build.
- Now Fiji Build will most likely complain that some libraries are missing, most importantly the central library ij.jar, you will need to specify which jars are required for the build:
- open the file pom.xml in the src-plugins/ directory with a text editor of your choice
- find the section "From source"
- you will find a lot of entries which look like CLASSPATH(plugins/Whatever_plugin.jar)=jars/ij.jar
- Add an entry for your plugin and add the required jars, e.g. CLASSPATH(plugins/My_plugin.jar)=jars/ij.jar:jars/imglib.jar - if you want to write a plugin using imglib
- save the file and build again
- After testing, you might realize that you need changes. In this case, decide if you want to amend the commit (if there was a silly typo, you might want to hide that fact from the world), or if you want to make a new commit.
- When everything is done and fine, publish (which is called "push" in Git)!
The plugins/Examples folder contains numerous plugins in all supported languages, heavily commented.
See Scripting Help for details on how to develop, test and run ImageJ plugins written in the supported scripting languages.
There are also Scripting comparisons.
See also the PlugIn Design Guidelines.
Plugins in the Fiji Source Tree
The sources for many useful plugins are maintained in src-plugins/ in the Fiji source tree. In order to be built by the Fiji Build System, they must be properly Mavenized. In other words, there should be a pom.xml file that describes the plugin, and its artifactId should be added as a module in the modules section of the pom file for src-plugins (alphabetically, please).
See also Maven_-_Frequently_Asked_Questions
Some projects have their own source code repositories. In this case, we do not copy the files into src-plugins/, but use submodules.
If the project uses a different source code management tool than Git, no problem, just mirror it.
Then add the submodule. Example:
# clone the VIB repository git clone ssh://email@example.com/srv/git/VIB.git # first time, commit-submodule need to know the target, too ("jars/jgit.jar" in this case) ./fiji bin/commit-submodule.py VIB plugins/VIB_.jar
Submodules must be Maven projects themselves.
So what does commit-submodule.py do? It
- verifies that the submodule is pushed,
- makes sure that the submodule is recorded in .gitmodules,
- adds the target to the modules/pom.xml file,
- adds the target to .gitignore so it is not committed by accident, and
- finally commits the result
When you are testing Fiji, you may want to measure the code coverage of your tests - one way is described in the page Code Coverage in Fiji.
At some point, you might want to debug whatever you wrote. There's a small Debugging intro page.
When you want to discuss your changes to some Fiji component, the preferred way is to inline a patch and send it to the fiji-devel mailing list. You can also send a link to your repository, e.g. a fork of the Fiji repository on github.com, but then commenting is not as easy (and the discussion will involve fewer developers).
To point at specific code on IRC or via mail, you can also do so by posting links to our Gitweb. There is even a little shell script in fiji.git that helps you finding the link:
This script will open the appropriate link with xdg-open. It can deal with files, even in submodules, and commits (for commits, your current directory must be inside the appropriate Git checkout). For files, you can append ":<linenumber>" to the file name to get a link to a specific line.
Forking on GitHub
Alternatively, you can make an account for yourself on GitHub and fork fiji.git:
- clone it
If you already worked in an existing checkout of fiji.git, no problem, you can connect that to the new remote:
- git remote add github github.com:<user>/fiji (where <user> is your account on GitHub)
- git config branch.<branch>.remote github (where "<branch>" is the branch you want to connect to GitHub, typically master)
- git config branch.<branch>.merge refs/heads/<branch>
- git push github <branch> to push the current state
Contributing to Fiji's existing plugins
Sometimes you may want to contribute to Fiji's existing plugins, for example, a bug is found in one plugin and you want to fix it, or you would like to improve one plugin by adding more functions.
Every plugin has its own git repository in Fiji. For example, the GraphCut plugin's repository is GraphCut. This structure allows for easy, independent development of the individual parts of which the base version of Fiji consists.
To contribute to Fiji's GraphCut plugin:
- Fork that repository by clicking the "Fork" button
- Clone it - git clone https://github.com/username/Graph_Cut.git
- Configure remotes
- cd Graph_Cut
- git remote add upstream https://github.com/fiji/Graph_Cut.git
- git fetch upstream
- Create a topic branch
- git branch mybranch
- git checkout mybranch
- Make changes and commit them to your topic branch
- Push the commits to your github repository
- Send the pull request
Letting us know
After you published your contributions, you probably also want to let us know what you did, so just send a mail to the Fiji devel mailing list.
A plugin wants to be used. Therefore you want to give users some information about it, and most likely also a tutorial how to use it.
If you have an account on this Wiki, you can easily create new tutorials with the Tutorial Maker.
Further reading for developers
- Overview of Fiji's source code
- Description of ImageJ's plugin architecture
- Tips for developers
- ImageJ1 Javadoc ZIP (for offline usage)
- ImageJ2 Javadoc ZIP (for offline usage)
- Developers HowTo
- ImageJ plugin writing tutorial
- ImageJ programming tutorials
- Uploading plugins
- Developing Fiji in Eclipse
- Project ideas
- Code Coverage in Fiji
- Introduction to debugging
- Profiling Java Code
- Tips for C++ developers