#  pyMINFLUX
Reader, analyzer, and viewer of MINFLUX raw data.
<p align="center">
<img width="800" src="https://pyminflux.ethz.ch/img/pyminflux.png">
</p>
## Installation
### Apps
Compiled executables (apps) for Linux, macOS and Windows can be downloaded from the [release page](https://github.com/bsse-scf/pyMINFLUX/releases/latest).
**Please note**: since pyMINFLUX on macOS comes from an *unidentified developer*, you might need to make an exception in the macOS security settings when launching it for the first time. To do this, right-click on the application icon and select `Open`. After this initial setup, you can simply double-click the icon to launch pyMINFLUX normally.
### pip
The latest version of pyMINFLUX can also be installed from [pypi.org](https://pypi.org/project/pyminflux/). pyMINFLUX is compatible with and tested on Python 3.10 and 3.11. It is recommended to install pyMINFLUX in a conda environment as follows:
```sh
$ conda create -n pyminflux-env python=3.11 # or 3.10
$ conda activate pyminflux-env
$ pip install --upgrade pyminflux
```
pyMINFLUX can then easily be run from the command line:
```sh
$ pyminflux
```
## For developers and tinkerers
pyMINFLUX is compatible with and tested on Python 3.10 and 3.11. For development, it is recommended to install pyMINFLUX in editable mode in a [conda](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) environment as follows:
```sh
$ conda create -n pyminflux-env python=3.11 # or 3.10
$ conda activate pyminflux-env
$ git clone https://github.com/bsse-scf/pyMINFLUX /path/to/pyminflux
$ cd /path/to/pyminflux
$ python -m pip install -e .
$ pip install -r dev-requirements.txt
```
If you want to participate to the development of pyMINFLUX, please have a look at [how you can contribute](CONTRIBUTING.md) and at our [code of conduct](CODE_OF_CONDUCT.md).
### Running pyMINFLUX from console
```sh
$ cd /path/to/pyminflux
$ python pyminflux/main.py # As a Python script, or
$ pyminflux # as a standalone tool
```
### Using the pyMINFLUX API from Python scripts or Jupyter Notebooks
The graphical user interface is not the only way to use pyMINFLUX. Indeed, the pyMINFLUX core library can be integrated in Python scripts or Jupyter Notebooks. The documentation for the pyMIMFLUX core API can be found on [https://pyminflux.ethz.ch/api/pyminflux/](https://pyminflux.ethz.ch/api/pyminflux/); an example Jupyter Notebook is [bundled with the code](/examples/processing.ipynb).
## User manual
The user manual is hosted in the [project wiki](https://github.com/bsse-scf/pyMINFLUX/wiki/pyMINFLUX-user-manual).
## Official website
The official pyMINFLUX website is on https://pyminflux.ethz.ch.
## pyMINFLUX mailing list
Join the [pyMINFLUX mailing list](https://sympa.ethz.ch/sympa/subscribe/pyminflux) for release announcements and further discussions.
## Contributing to pyMINFLUX
We value the contribution of our community members, and to make sure that everyone can profit from this collaboration, we ask you to have a look at our [CONTRIBUTING](./CONTRIBUTING.md) and [CODE OF CONDUCT](./CODE_OF_CONDUCT.md) documents.
## Citing pyMINFLUX
If you use pyMINFLUX in your research, please cite this repository as follows:
> Aaron Ponti, Javier Casares Arias, & Thomas Horn. (2023). pyMINFLUX. Zenodo. [](https://doi.org/10.5281/zenodo.7895501)
Raw data
{
"_id": null,
"home_page": "https://github.com/bsse-scf/pyMINFLUX",
"name": "pyminflux",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "MINFLUX, Visualization, Filtering, Analysis, Python",
"author": "Aaron Ponti",
"author_email": "aaron.ponti@bsse.ethz.ch",
"download_url": "https://files.pythonhosted.org/packages/1c/07/cc9e41116cdf21f7080a18762800026cfe3028098def0a405feb959716f0/pyminflux-0.5.0.tar.gz",
"platform": null,
"description": "#  pyMINFLUX\n\nReader, analyzer, and viewer of MINFLUX raw data.\n\n<p align=\"center\">\n <img width=\"800\" src=\"https://pyminflux.ethz.ch/img/pyminflux.png\">\n</p>\n\n## Installation\n\n### Apps\n\nCompiled executables (apps) for Linux, macOS and Windows can be downloaded from the [release page](https://github.com/bsse-scf/pyMINFLUX/releases/latest). \n\n**Please note**: since pyMINFLUX on macOS comes from an *unidentified developer*, you might need to make an exception in the macOS security settings when launching it for the first time. To do this, right-click on the application icon and select `Open`. After this initial setup, you can simply double-click the icon to launch pyMINFLUX normally.\n\n### pip\n\nThe latest version of pyMINFLUX can also be installed from [pypi.org](https://pypi.org/project/pyminflux/). pyMINFLUX is compatible with and tested on Python 3.10 and 3.11. It is recommended to install pyMINFLUX in a conda environment as follows:\n\n```sh\n$ conda create -n pyminflux-env python=3.11 # or 3.10\n$ conda activate pyminflux-env\n$ pip install --upgrade pyminflux\n```\n\npyMINFLUX can then easily be run from the command line:\n\n```sh\n$ pyminflux\n```\n\n## For developers and tinkerers\n\npyMINFLUX is compatible with and tested on Python 3.10 and 3.11. For development, it is recommended to install pyMINFLUX in editable mode in a [conda](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) environment as follows:\n\n```sh\n$ conda create -n pyminflux-env python=3.11 # or 3.10\n$ conda activate pyminflux-env\n$ git clone https://github.com/bsse-scf/pyMINFLUX /path/to/pyminflux\n$ cd /path/to/pyminflux\n$ python -m pip install -e .\n$ pip install -r dev-requirements.txt\n```\n\nIf you want to participate to the development of pyMINFLUX, please have a look at [how you can contribute](CONTRIBUTING.md) and at our [code of conduct](CODE_OF_CONDUCT.md).\n\n### Running pyMINFLUX from console\n\n```sh\n$ cd /path/to/pyminflux\n$ python pyminflux/main.py # As a Python script, or\n$ pyminflux # as a standalone tool\n```\n\n### Using the pyMINFLUX API from Python scripts or Jupyter Notebooks\n\nThe graphical user interface is not the only way to use pyMINFLUX. Indeed, the pyMINFLUX core library can be integrated in Python scripts or Jupyter Notebooks. The documentation for the pyMIMFLUX core API can be found on [https://pyminflux.ethz.ch/api/pyminflux/](https://pyminflux.ethz.ch/api/pyminflux/); an example Jupyter Notebook is [bundled with the code](/examples/processing.ipynb).\n\n## User manual\n\nThe user manual is hosted in the [project wiki](https://github.com/bsse-scf/pyMINFLUX/wiki/pyMINFLUX-user-manual).\n\n## Official website\n\nThe official pyMINFLUX website is on https://pyminflux.ethz.ch.\n\n## pyMINFLUX mailing list\n\nJoin the [pyMINFLUX mailing list](https://sympa.ethz.ch/sympa/subscribe/pyminflux) for release announcements and further discussions.\n\n## Contributing to pyMINFLUX\n\nWe value the contribution of our community members, and to make sure that everyone can profit from this collaboration, we ask you to have a look at our [CONTRIBUTING](./CONTRIBUTING.md) and [CODE OF CONDUCT](./CODE_OF_CONDUCT.md) documents.\n\n## Citing pyMINFLUX\n\nIf you use pyMINFLUX in your research, please cite this repository as follows:\n\n> Aaron Ponti, Javier Casares Arias, & Thomas Horn. (2023). pyMINFLUX. Zenodo. [](https://doi.org/10.5281/zenodo.7895501)\n\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Reader, processor, and viewer of MINFLUX raw data.",
"version": "0.5.0",
"project_urls": {
"Bug Tracker": "https://github.com/bsse-scf/pyMINFLUX/issues",
"Documentation": "https://github.com/bsse-scf/pyMINFLUX/wiki",
"Homepage": "https://github.com/bsse-scf/pyMINFLUX",
"Repository": "https://github.com/bsse-scf/pyMINFLUX"
},
"split_keywords": [
"minflux",
" visualization",
" filtering",
" analysis",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be238567303d06559e7c8db49114dab5b28ecaf26c3bcb92a47d5c54085c0e1e",
"md5": "954ae35801eefbc37a98589448bc8549",
"sha256": "7001a9c9456370f0acacbed7f066fde466577197baf9538ab9f8ad0b957f3bba"
},
"downloads": -1,
"filename": "pyminflux-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "954ae35801eefbc37a98589448bc8549",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 622842,
"upload_time": "2024-10-25T14:33:06",
"upload_time_iso_8601": "2024-10-25T14:33:06.986772Z",
"url": "https://files.pythonhosted.org/packages/be/23/8567303d06559e7c8db49114dab5b28ecaf26c3bcb92a47d5c54085c0e1e/pyminflux-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1c07cc9e41116cdf21f7080a18762800026cfe3028098def0a405feb959716f0",
"md5": "44ef39c6f956317d0751b932eb930432",
"sha256": "6899bafc5adfc93648a96920551777123a5573628bc98a429d3d83990b6983aa"
},
"downloads": -1,
"filename": "pyminflux-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "44ef39c6f956317d0751b932eb930432",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 567571,
"upload_time": "2024-10-25T14:33:09",
"upload_time_iso_8601": "2024-10-25T14:33:09.448002Z",
"url": "https://files.pythonhosted.org/packages/1c/07/cc9e41116cdf21f7080a18762800026cfe3028098def0a405feb959716f0/pyminflux-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 14:33:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bsse-scf",
"github_project": "pyMINFLUX",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyminflux"
}
JSON
