README

Installation
------------

NEP-fitting is implemented as a pair of plugins for the Python Microscopy Environment (PYME).

PYME installation instructions can be found at:
http://www.python-microscopy.org/doc/Installation/InstallationWithAnaconda.html

NEP-fitting can be installed using anaconda (general use) or setuptools (use and software development).

To install using anaconda:

0) You may want to make sure conda is up to date, e.g. 'conda update conda' or 'conda update -n <your environment name> conda'
1) Run 'conda install -c barentine nep-fitting'
2) Close python and test installation by running 'STEDFitter' on the terminal, or by running 'dh5view', loading an
image, and selecting 'sted_psf_fitting' from the 'modules' drop-down menu.

To install using setuptools:

1) Clone this repository
2) Run 'python nep-fitting/setup.py install'
3) Run 'python nep-fitting/install_plugin.py'
4) Test installation by running 'dh5view', loading an image, and selecting 'sted_psf_fitting' from the 'modules'
drop-down menu.

Once installed, the nep-fitting functionality is accessible by choosing the 'sted_psf_fitting' module from the
modules menu within the PYME data viewer (dh5view).