| Name | okapi-em JSON |
| Version |
0.0.10
JSON |
| download |
| home_page | |
| Summary | napari plugin to deal with charging artifacts in tomography electron microscopy data |
| upload_time | 2023-08-14 12:50:15 |
| maintainer | |
| docs_url | None |
| author | Luis Perdigao |
| requires_python | >=3.7 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# okapi-em
https://github.com/rosalindfranklininstitute/okapi-em
<!--
[](https://github.com/rosalindfranklininstitute/okapi-em/raw/main/LICENSE)
[](https://pypi.org/project/okapi-em)
[](https://python.org)
[](https://github.com/rosalindfranklininstitute/okapi-em/actions)
[](https://codecov.io/gh/rosalindfranklininstitute/okapi-em)
[](https://napari-hub.org/plugins/okapi-em)
-->
A napari plugin for processing serial-FIB-SEM data.
Powered by [chafer] and [quoll].
A full description of this software is presented in biorXiv preprint paper:
https://doi.org/10.1101/2022.12.15.520541
This [napari] plugin contains the following tools:
- slice alignment using constrained SIFT
- two charge artifact suppression filters
- directional fourier bandapass filter
- line-by-line filter function optimiser and subtraction (requires charge artifact labels) - uses [chafer]
- fourier ring correlation (FRC) resolution estimation - uses [quoll]
----------------------------------
This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.
<!--
Don't miss the full getting started guide to set up your new package:
https://github.com/napari/cookiecutter-napari-plugin#getting-started
and review the napari docs for plugin developers:
https://napari.org/plugins/stable/index.html
-->
## Installation
You can install `okapi-em` via [pip]:
`>pip install okapi-em`
or using napari's plugin installation engine `Plugins->Install/Uninstall Plugins...` and filter for **Okapi-EM**.
For installing in development mode , clone this package then navigate to the cloned `okapi-em` folder and run:
`>pip install -e .`
Okapi-EM is a napari plugin. Launching napari is therefore required.
`>napari`
and then navigate `Menu->Plugins->Okapi-EM`
Note that to launch napari in older versions of python (<=3.7) you will need to use the command:
`>python -m napari`
## Computing requirements
Okapi-EM does not require powerful computers to run. None of the tools use GPU accelaration.
The minimum recommended RAM depends on the size of the data being used in napari. For a full image stack of 1Gb, it is recommended that user ensure that 3Gb of RAM is available or can be used. Modern OS's can extend physical RAM using `swap` memory (Linux) or cache (in Windows and also known as virtual memory), but processing can be significantly slower.
## Contributing
Contributions are very welcome. Tests can be run with [tox], please ensure
the coverage at least stays the same before you submit a pull request.
## License
Distributed under the terms of the [Apache Software License 2.0] license,
"okapi-em" is free and open source software
## Citing
Please cite usage using the following reference.
Perdigão, L. M. A. et al. Okapi-EM – a napari plugin for processing and analysing cryogenic serial FIB/SEM images. 2022.12.15.520541 Preprint at https://doi.org/10.1101/2022.12.15.520541 (2022).
## Issues
There is currently a known issue with napari running in Linux machines, that it does not find the OpenGL driver correctly.
This will hopefully be resolved in the near future. If you bump into this issue we recommend trying to downgrade the python version. This is not an Okapi-EM problem.
If you encounter any problems, please file an issue along with a detailed description.
[quoll]: https://github.com/rosalindfranklininstitute/quoll
[chafer]: https://github.com/rosalindfranklininstitute/chafer
[napari]: https://github.com/napari/napari
[Cookiecutter]: https://github.com/audreyr/cookiecutter
[@napari]: https://github.com/napari
[MIT]: http://opensource.org/licenses/MIT
[BSD-3]: http://opensource.org/licenses/BSD-3-Clause
[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0
[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin
[tox]: https://tox.readthedocs.io/en/latest/
[pip]: https://pypi.org/project/pip/
[PyPI]: https://pypi.org/
Raw data
{
"_id": null,
"home_page": "",
"name": "okapi-em",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Luis Perdigao",
"author_email": "luis.perdigao@rfi.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/e9/b7/141a07d8ad30c11d46e980ddfb15eee617198dc8ad7fe5f973a734fb27e9/okapi-em-0.0.10.tar.gz",
"platform": null,
"description": "# okapi-em\r\n\r\nhttps://github.com/rosalindfranklininstitute/okapi-em\r\n\r\n<!--\r\n[](https://github.com/rosalindfranklininstitute/okapi-em/raw/main/LICENSE)\r\n[](https://pypi.org/project/okapi-em)\r\n[](https://python.org)\r\n[](https://github.com/rosalindfranklininstitute/okapi-em/actions)\r\n[](https://codecov.io/gh/rosalindfranklininstitute/okapi-em)\r\n[](https://napari-hub.org/plugins/okapi-em)\r\n-->\r\n\r\nA napari plugin for processing serial-FIB-SEM data.\r\n\r\nPowered by [chafer] and [quoll].\r\n\r\n\r\nA full description of this software is presented in biorXiv preprint paper:\r\n\r\nhttps://doi.org/10.1101/2022.12.15.520541\r\n\r\nThis [napari] plugin contains the following tools:\r\n\r\n- slice alignment using constrained SIFT\r\n- two charge artifact suppression filters\r\n - directional fourier bandapass filter\r\n - line-by-line filter function optimiser and subtraction (requires charge artifact labels) - uses [chafer]\r\n- fourier ring correlation (FRC) resolution estimation - uses [quoll]\r\n\r\n----------------------------------\r\n\r\nThis [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.\r\n\r\n<!--\r\nDon't miss the full getting started guide to set up your new package:\r\nhttps://github.com/napari/cookiecutter-napari-plugin#getting-started\r\n\r\nand review the napari docs for plugin developers:\r\nhttps://napari.org/plugins/stable/index.html\r\n-->\r\n\r\n## Installation\r\n\r\nYou can install `okapi-em` via [pip]:\r\n\r\n`>pip install okapi-em`\r\n\r\nor using napari's plugin installation engine `Plugins->Install/Uninstall Plugins...` and filter for **Okapi-EM**.\r\n\r\nFor installing in development mode , clone this package then navigate to the cloned `okapi-em` folder and run:\r\n\r\n`>pip install -e .`\r\n\r\nOkapi-EM is a napari plugin. Launching napari is therefore required.\r\n\r\n`>napari`\r\n\r\nand then navigate `Menu->Plugins->Okapi-EM`\r\n\r\nNote that to launch napari in older versions of python (<=3.7) you will need to use the command:\r\n\r\n`>python -m napari`\r\n\r\n## Computing requirements\r\nOkapi-EM does not require powerful computers to run. None of the tools use GPU accelaration.\r\n\r\nThe minimum recommended RAM depends on the size of the data being used in napari. For a full image stack of 1Gb, it is recommended that user ensure that 3Gb of RAM is available or can be used. Modern OS's can extend physical RAM using `swap` memory (Linux) or cache (in Windows and also known as virtual memory), but processing can be significantly slower.\r\n\r\n## Contributing\r\n\r\nContributions are very welcome. Tests can be run with [tox], please ensure\r\nthe coverage at least stays the same before you submit a pull request.\r\n\r\n## License\r\n\r\nDistributed under the terms of the [Apache Software License 2.0] license,\r\n\"okapi-em\" is free and open source software\r\n\r\n## Citing\r\n\r\nPlease cite usage using the following reference.\r\n\r\nPerdig\u00e3o, L. M. A. et al. Okapi-EM \u2013 a napari plugin for processing and analysing cryogenic serial FIB/SEM images. 2022.12.15.520541 Preprint at https://doi.org/10.1101/2022.12.15.520541 (2022).\r\n\r\n\r\n## Issues\r\n\r\nThere is currently a known issue with napari running in Linux machines, that it does not find the OpenGL driver correctly.\r\nThis will hopefully be resolved in the near future. If you bump into this issue we recommend trying to downgrade the python version. This is not an Okapi-EM problem.\r\n\r\nIf you encounter any problems, please file an issue along with a detailed description.\r\n\r\n[quoll]: https://github.com/rosalindfranklininstitute/quoll\r\n[chafer]: https://github.com/rosalindfranklininstitute/chafer\r\n[napari]: https://github.com/napari/napari\r\n[Cookiecutter]: https://github.com/audreyr/cookiecutter\r\n[@napari]: https://github.com/napari\r\n[MIT]: http://opensource.org/licenses/MIT\r\n[BSD-3]: http://opensource.org/licenses/BSD-3-Clause\r\n[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt\r\n[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt\r\n[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0\r\n[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt\r\n[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin\r\n\r\n\r\n[tox]: https://tox.readthedocs.io/en/latest/\r\n[pip]: https://pypi.org/project/pip/\r\n[PyPI]: https://pypi.org/\r\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "napari plugin to deal with charging artifacts in tomography electron microscopy data",
"version": "0.0.10",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d78d173ea41381485a40f3f1baa2df8189c83aa318255f00a4c7a82c4c940ed1",
"md5": "8cd20e1ff890bf51310bc17024044813",
"sha256": "6652865c246e0833bd4d9e0dc5a388fdaffe1121f9b8a9ca86715cff1bdc1504"
},
"downloads": -1,
"filename": "okapi_em-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8cd20e1ff890bf51310bc17024044813",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 45161,
"upload_time": "2023-08-14T12:50:14",
"upload_time_iso_8601": "2023-08-14T12:50:14.581549Z",
"url": "https://files.pythonhosted.org/packages/d7/8d/173ea41381485a40f3f1baa2df8189c83aa318255f00a4c7a82c4c940ed1/okapi_em-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e9b7141a07d8ad30c11d46e980ddfb15eee617198dc8ad7fe5f973a734fb27e9",
"md5": "e14e175dc97c6d79f6b14af0f87629cb",
"sha256": "b38468f8b5ab9c6259f24761e633660514943872bb77b61f3d2cdf5f7f5cae7b"
},
"downloads": -1,
"filename": "okapi-em-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "e14e175dc97c6d79f6b14af0f87629cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 43856,
"upload_time": "2023-08-14T12:50:15",
"upload_time_iso_8601": "2023-08-14T12:50:15.984658Z",
"url": "https://files.pythonhosted.org/packages/e9/b7/141a07d8ad30c11d46e980ddfb15eee617198dc8ad7fe5f973a734fb27e9/okapi-em-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-14 12:50:15",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "okapi-em"
}
