https://github.com/ome/bio-formats-documentation
Bio-Formats documentation
https://github.com/ome/bio-formats-documentation
bio-formats documentation
Last synced: 9 months ago
JSON representation
Bio-Formats documentation
- Host: GitHub
- URL: https://github.com/ome/bio-formats-documentation
- Owner: ome
- License: bsd-2-clause
- Created: 2018-02-06T14:00:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-08-20T14:38:30.000Z (10 months ago)
- Last Synced: 2025-08-20T16:32:59.510Z (10 months ago)
- Topics: bio-formats, documentation
- Language: Java
- Homepage: https://www.openmicroscopy.org/bio-formats/
- Size: 9.44 MB
- Stars: 8
- Watchers: 10
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Bio-Formats
[](https://bio-formats.readthedocs.io/en/stable/?badge=stable)
Bio-Formats is a standalone Java library for reading and writing life sciences
image file formats. It is capable of parsing both pixels and metadata for a
large number of formats, as well as writing to several formats.
If you are having an issue with Bio-Formats and need support, please see the
[support page](./SUPPORT.md).
Purpose
-------
Bio-Formats' primary purpose is to convert proprietary microscopy data into
an open standard called the OME data model, particularly into the OME-TIFF
file format. See [About Bio-Formats](https://docs.openmicroscopy.org/latest/bio-formats/about/index.html)
for further information.
Supported formats
-----------------
Bio-Formats supports [more than a hundred file
formats](https://docs.openmicroscopy.org/latest/bio-formats/supported-formats.html).
For users
---------
[Many software packages](https://docs.openmicroscopy.org/latest/bio-formats/users/index.html)
use Bio-Formats to read and write microscopy formats.
For developers
--------------
You can use Bio-Formats to easily [support these formats in your software](https://docs.openmicroscopy.org/latest/bio-formats/developers/java-library.html).
More information
----------------
For more information, see the [Bio-Formats web
site](https://www.openmicroscopy.org/bio-formats).
Pull request testing
--------------------
We welcome pull requests from anyone, but ask that you please verify the
following before submitting a pull request:
* verify that the branch merges cleanly into ```develop```
* verify that the branch compiles with the ```clean jars tools``` Ant targets
* verify that the branch compiles using Maven
* verify that the branch does not use syntax or API specific to Java 1.8+
* run the unit tests (```ant test```) and correct any failures
* test at least one file in each affected format, using the ```showinf```
command
* internal developers only: [run the data
tests](docs/sphinx/developers/commit-testing.rst)
against directories corresponding to the affected format(s)
* make sure that your commits contain the correct authorship information and,
if necessary, a signed-off-by line
* make sure that the commit messages or pull request comment contains
sufficient information for the reviewer(s) to understand what problem was
fixed and how to test it