Skip to content

README.md

Latest commit

 

History

History
27 lines (20 loc) · 1.06 KB

README.md

File metadata and controls

27 lines (20 loc) · 1.06 KB

Documentation for Imspector

Documentation Status

What is Imspector

Imspector is a software for image acquisition and analysis in high resolution microscopy. It is developed at the Max Planck Institute of Biophysical Chemistry at the department of NanoBiophotonics and at the Abberior Instruments GmbH.

Development Environment for this documentation

  1. have Python installed
  2. have this repository cloned into ImspectorDocs
  3. create and activate a python virtual environment
  4. pip install -U -r ImspectorDocs/requirements.txt

After this you should be able to build the documentation:

  1. cd ImspectorDocs/docs/
  2. make html or .\make.bat html
  3. now ImspectorDocs\docs\_build\html will contain the built docs

The documentation is built after each push. Read the latest version at ReadTheDocs.org.