BrightEyes-ISM
A toolbox for analysing and simulating Image Scanning Microscopy (ISM) datasets. The analysis module contains libraries for:
- Adaptive Pixel Reassignment (https://doi.org/10.1038/s41592-018-0291-9)
- Focus-ISM (https://doi.org/10.1038/s41467-022-35333-y)
- Image Deconvolution (https://doi.org/10.1088/1361-6420/accdc5)
- Fourier Ring Correlation (https://doi.org/10.1038/s41467-019-11024-z)
- Image and ISM datasets visualization
- Miscellaneous tools
The simulation module contains libraries for:
- Generation of ISM point spread functions (https://doi.org/10.48550/arXiv.2502.03170)
- Generation of tubulin phantom samples
The dataio module contains libraries for:
- Reading data and metadata from the MCS software (https://doi.org/10.21105/joss.07125).
MCS data format support has been moved to brighteyes-mcs-reader. Legacy MCS reading is available from brighteyes_mcs_reader.reader_legacy.
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
scikit-image
scikit-learn
matplotlib
joblib
tqdm
h5py
statsmodels
matplotlib-scalebar
torch
torchvision
zernikepy
psf-generator
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.
- Fork the project.
- Create a branch for your feature:
git checkout -b cool-new-feature - Commit your changes:
git commit -am 'My new feature' - Push to the branch:
git push origin cool-new-feature - 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.
3 maintainers
Metadata
3 maintainers
Release files for brighteyes-ism 1.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| brighteyes_ism-1.5.1.tar.gz | 70.9 kB | With provenance | Details for brighteyes_ism-1.5.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| brighteyes_ism-1.5.1-py3-none-any.whl | Python 3 | none | any | Details for brighteyes_ism-1.5.1-py3-none-any.whl |
Total release size: 132.9 kB
Release files / brighteyes_ism-1.5.1.tar.gz
| Download URL | brighteyes_ism-1.5.1.tar.gz |
|---|---|
| Size | 70.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fd7194867783d208c8d8acb93bc00ae15b21e4c9624d35aa2a309e66a7644463
|
|
BLAKE2b-256 checksum How to use checksums |
808720c6b1a1a7a9f7cc0827b9c881a6d492d7fb94bca8979c9c620a42605b0b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 23, 2026.
Transparency logRelease files / brighteyes_ism-1.5.1-py3-none-any.whl
| Download URL | brighteyes_ism-1.5.1-py3-none-any.whl |
|---|---|
| Size | 62.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ff2b308ee0809fced483b5b66faa78ec3612c548c194e2fe7bdac4a8959fa80f
|
|
BLAKE2b-256 checksum How to use checksums |
445a0c14df86d7169ce21b4659ebad8c6ce493122a15dc7f1defc25139cedd39
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 23, 2026.
Transparency logSecurity for brighteyes-ism 1.5.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for brighteyes_ism-1.5.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 23, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
