You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

25 lines
1022 B

  1. .. nd2reader documentation master file, created by
  2. sphinx-quickstart on Mon Mar 6 21:17:58 2017.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. ``nd2reader``: a pure-Python package for reading Nikon .nd2 files
  6. =================================================================
  7. `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.
  8. 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. To get started, see the quick start tutorial.
  9. .. toctree::
  10. :maxdepth: 4
  11. :caption: Contents:
  12. nd2reader quick start tutorial <tutorial>
  13. nd2reader API reference <nd2reader>
  14. Indices and tables
  15. ==================
  16. * :ref:`genindex`
  17. * :ref:`modindex`
  18. * :ref:`search`