The following documentation is for developers wishing to write OMERO client code or extend the OMERO server. Instructions on downloading <>, installation and administering OMERO can be found under the /sysadmins/index of the main site.
OMERO is an open source client/server system written in Java for visualizing, managing, and annotating microscope images and metadata. The allows clients to be written in Java </developers/Java>, Python </developers/Python>, C++ </developers/Cpp> or MATLAB </developers/Matlab>. OMERO releases include a Java client OMERO.insight, a Python-based web client OMERO.web and the /developers/cli/index, which also uses Python. There is also an ImageJ plugin. OMERO can be extended by modifying these clients or by writing your own in any of the supported languages (see figure). OMERO also supports a Scripting Service <scripts/index> which allows Python scripts to be run on the server and called from any of the other clients.
OMERO is designed, developed and released by the , with contributions from OMERO is released under the GNU General Public License (GPL) with commercial licenses and customization available from . You can read about how OMERO has developed since the project started in the /users/history. We ask contributors to sign once the Contributor License Agreement (CLA) . When signed, please do send the agreement to contributors at openmicroscopy.org.
For help with any aspect of OMERO, see details of our forums and mailing lists <>.
whatsnew python3-migration installation build-system GettingStarted testing
Python PythonBlitzGateway cli/index Java Matlab Cpp json-api
analysis Tables
scripts/index scripts/user-guide scripts/style-guide scripts/matlab-scripts scripts/advanced
Web Web/Deployment Web/CreateApp Web/ReleaseApp Web/LinkingFromWebclient Web/WebclientPlugin Web/EditingOmeroWeb Web/WebGateway Web/ViewPort Web/WritingViews Web/WritingTemplates Web/CSRF Web/Webclient
Note
With the release of OMERO 5.3.0, the OMERO.insight desktop client has entered maintenance mode, meaning it will only be updated if a major bug is discovered. Instead, the OME team will be focusing on developing the web clients. As a result, coding against this client is no longer recommended. Technical documentation can be found at https://omero-insight.readthedocs.io/en/latest/.
OMERO can be extended by modifying these clients or by writing your own in any of the supported languages.
GettingStarted/AdvancedClientDevelopment Modules/Api Modules/Api/AdminInterface Modules/Delete Clients/ImportLibrary Modules/TempFileManager Modules/ExceptionHandling logging Server/GraphRequests Server/GraphsMigration
Model Model/StructuredAnnotations Model/EveryObject Model/Units Model/KeyValuePairs Model/XsltTransformations Model/Containers
Modules/Search Search/FileParsers Modules/Search/Bridges
Server/PasswordProvider Server/LoginAttemptListener Server/Ldap Server/SecurityRoles Server/SecuritySystem Server/Permissions
Server Server/ExtendingOmero server-blitz Server/FS ImportFS server-processor server-rendering Server/Clustering Server/CollectionCounts Server/HowToCreateAService Server/Sessions Server/Aop Server/Context Server/Events Server/Properties Server/Queries Server/Throttling Server/RenderingEngine Server/ScalingOmero Server/SqlAction Server/LightAdmins Server/ObjectGraphs Server/GraphsImpl