|
|
- # nd2reader
-
- [](https://travis-ci.org/rbnvrw/nd2reader)
- [](https://codeclimate.com/github/rbnvrw/nd2reader/coverage)
- [](https://codeclimate.com/github/rbnvrw/nd2reader)
-
- ### About
-
- `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.
-
- ### Documentation
-
- The documentation is available [here](http://www.lighthacking.nl/nd2reader/).
-
- ### Installation
-
- For now, the package is only available via GitHub. Install it using:
-
- ```
- pip install --upgrade https://github.com/rbnvrw/nd2reader/tarball/master
- ```
-
- If you don't already have the packages `numpy`, `pims`, `six` and `xmltodict`, they will be installed automatically if you use the `setup.py` script.
- `nd2reader` is an order of magnitude faster in Python 3. I recommend using it unless you have no other choice. Python 2.7 and Python >= 3.4 are supported.
-
- ### ND2s
-
- `nd2reader` follows the [pims](https://github.com/soft-matter/pims) framework. To open a file and show the first frame:
-
- ```python
- from nd2reader import ND2Reader
- import matplotlib.pyplot as plt
-
- with ND2Reader('my_directory/example.nd2') as images:
- plt.imshow(images[0])
- ```
-
- After opening the file, all `pims` features are supported. Please refer to the [pims documentation](http://soft-matter.github.io/pims/).
-
- #### 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.
-
- ### Contributing
-
- If you'd like to help with the development of nd2reader or just have an idea for improvement, please see the [contributing](https://github.com/rbnvrw/nd2reader/blob/master/CONTRIBUTING.md) page
- for more information.
-
- ### Bug Reports and Features
-
- If this fails to work exactly as expected, please open an [issue](https://github.com/rbnvrw/nd2reader/issues).
- If you get an unhandled exception, please paste the entire stack trace into the issue as well.
-
- ### Acknowledgments
-
- PIMS modified version by Ruben Verweij.
-
- Original version by Jim Rybarski. Support for the development of this package was partially provided by the [Finkelstein Laboratory](http://finkelsteinlab.org/).
|
