The following documentation is for developers wishing to write OMERO client code or extend the OMERO server. Instructions on :downloads:`downloading <>`, installation and administering OMERO can be found under the :doc:`/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 |OmeroApi| allows clients to be written in :doc:`Java </developers/Java>`, :doc:`Python </developers/Python>`, :doc:`C++ </developers/Cpp>` or :doc:`MATLAB </developers/Matlab>`. OMERO releases include a Java client OMERO.insight, a Python-based web client OMERO.web and the :doc:`/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 :doc:`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 |OME|, with contributions
from |Glencoe| OMERO is released under the GNU General Public License (GPL)
with commercial licenses and customization available from |Glencoe|. You can
read about how OMERO has developed since the project started in the
:doc:`/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 :community:`forums and mailing lists <>`.
.. toctree::
:maxdepth: 1
:titlesonly:
whatsnew
python3-migration
installation
build-system
GettingStarted
testing
.. toctree::
:maxdepth: 1
:titlesonly:
Python
PythonBlitzGateway
cli/index
Java
Matlab
Cpp
json-api
.. toctree::
:maxdepth: 2
:titlesonly:
analysis
Tables
.. toctree::
:maxdepth: 1
:titlesonly:
scripts/index
scripts/user-guide
scripts/style-guide
scripts/matlab-scripts
scripts/advanced
.. toctree::
:maxdepth: 1
:titlesonly:
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.
.. toctree::
:maxdepth: 1
:titlesonly:
GettingStarted/AdvancedClientDevelopment
Modules/Api
Modules/Api/AdminInterface
Modules/Delete
Clients/ImportLibrary
Modules/TempFileManager
Modules/ExceptionHandling
logging
Server/GraphRequests
Server/GraphsMigration
.. toctree::
:maxdepth: 1
:titlesonly:
Model
Model/StructuredAnnotations
Model/EveryObject
Model/Units
Model/KeyValuePairs
Model/XsltTransformations
Model/Containers
.. toctree::
:maxdepth: 1
:titlesonly:
Modules/Search
Search/FileParsers
Modules/Search/Bridges
.. toctree::
:maxdepth: 1
:titlesonly:
Server/PasswordProvider
Server/LoginAttemptListener
Server/Ldap
Server/SecurityRoles
Server/SecuritySystem
Server/Permissions
.. toctree::
:maxdepth: 1
:titlesonly:
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