Skip to content

A toolbox for analysing and simulating Image Scanning Microscopy (ISM) datasets.

License

Notifications You must be signed in to change notification settings

VicidominiLab/BrightEyes-ISM

Repository files navigation

BrightEyes-ISM

License PyPI Python Version

A toolbox for analysing and simulating Image Scanning Microscopy (ISM) datasets. The analysis module contains libraries for:

The simulation module contains libraries for:

The dataio module contains libraries for:


Installation

You can install brighteyes-ism via pip directly from GitHub:

pip install git+https://github.com/VicidominiLab/BrightEyes-ISM

or using the version on PyPI:

pip install brighteyes-ism

It requires the following Python packages

numpy
scipy
matplotlib
scikit-image
scikit-learn
poppy
PyCustomFocus==2.*
h5py
tqdm
statsmodels
matplotlib-scalebar

Documentation

You can find some examples of usage here:

https://github.com/VicidominiLab/BrightEyes-ISM/tree/main/examples

You can read the manual of this package on Read the Docs:

https://brighteyes-ism.readthedocs.io

Citation

If you find BrightEyes-ISM useful for your research, please cite it as:

Zunino, A., Slenders, E., Fersini, F. et al. Open-source tools enable accessible and advanced image scanning microscopy data analysis. Nat. Photon. (2023). https://doi.org/10.1038/s41566-023-01216-x

License

Distributed under the terms of the GNU GPL v3.0 license, "BrightEyes-ISM" is free and open source software

Contributing

You want to contribute? Great! Contributing works best if you creat a pull request with your changes.

  1. Fork the project.
  2. Create a branch for your feature: git checkout -b cool-new-feature
  3. Commit your changes: git commit -am 'My new feature'
  4. Push to the branch: git push origin cool-new-feature
  5. Submit a pull request!

If you are unfamilar with pull requests, you find more information on pull requests in the github help

Issues

If you encounter any problems, please file an issue along with a detailed description.

About

A toolbox for analysing and simulating Image Scanning Microscopy (ISM) datasets.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages