Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rbnvrw authored Jan 15, 2025
1 parent 207aa8b commit 6d82572
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,14 @@ for more information.**
`nd2reader` is a pure-Python package that reads images produced by NIS Elements 4.0+. It has only been definitively tested on NIS Elements 4.30.02 Build 1053. Support for older versions is being actively worked on.
The reader is written in the [pims](https://github.com/soft-matter/pims) framework, enabling easy access to multidimensional files, lazy slicing, and nice display in IPython.

### Alternatives

- [nd2](https://pypi.org/project/nd2/)
- Open a PR if you'd like to be listed here.

### Documentation

The documentation is available [here](http://www.lighthacking.nl/nd2reader/).
The documentation is available [here](https://open-science-tools.github.io/nd2reader/).

### Installation

Expand Down Expand Up @@ -63,7 +68,7 @@ After opening the file, all `pims` features are supported. Please refer to the [

#### Backwards compatibility

Older versions of `nd2reader` do not use the `pims` framework. To provide backwards compatibility, a legacy [Nd2](http://www.lighthacking.nl/nd2reader/nd2reader.html#module-nd2reader.legacy) class is provided.
Older versions of `nd2reader` do not use the `pims` framework. To provide backwards compatibility, a legacy [Nd2](https://open-science-tools.github.io/nd2reader/nd2reader.html#module-nd2reader.legacy) class is provided.

### Contributing

Expand Down

0 comments on commit 6d82572

Please sign in to comment.