[](https://github.com/openspyrit/spyrit/blob/master/LICENSE.md)
[](https://pypi.python.org/pypi/spyrit/)
[](https://spyrit.readthedocs.io/en/master/)
# SPyRiT
SPyRiT is a [PyTorch](https://pytorch.org/)-based toolbox for deep image reconstruction. While SPyRiT was originally designed for single-pixel image reconstruction, it can solve any linear reconstruction problem.
# Installation
The spyrit package is available for Linux, MacOs and Windows. We recommend to use a virtual environment.
## Linux and MacOs
(user mode)
```
pip install spyrit
```
(developper mode)
```
git clone https://github.com/openspyrit/spyrit.git
cd spyrit
pip install -e .
```
## Windows
On Windows you may need to install PyTorch first. It may also be necessary to run the following commands using administrator rights (e.g., starting your Python environment with administrator rights).
Adapt the two examples below to your configuration (see [here](https://pytorch.org/get-started/locally/) for the latest instructions)
(CPU version using `pip`)
```
pip3 install torch torchvision torchaudio
```
(GPU version using `conda`)
``` shell
conda install pytorch torchvision torchaudio pytorch-cuda=11.8 -c pytorch -c nvidia
```
Then, install SPyRiT using `pip`.
## Test
To check the installation, run in your python terminal:
```
import spyrit
```
## Examples
To start, check the [documentation tutorials](https://spyrit.readthedocs.io/en/latest/gallery/index.html).
More advanced reconstruction examples can be found in [spyrit-examples/tutorial](https://github.com/openspyrit/spyrit-examples/tree/master/tutorial). Run advanced tutorial in colab: [](https://colab.research.google.com/github/openspyrit/spyrit-examples/blob/master/tutorial/tuto_core_2d_drunet.ipynb)
# API Documentation
https://spyrit.readthedocs.io/
# Contributors (alphabetical order)
* Juan Abascal - [Website](https://juanabascal78.wixsite.com/juan-abascal-webpage)
* Thomas Baudier
* Sebastien Crombez
* Nicolas Ducros - [Website](https://www.creatis.insa-lyon.fr/~ducros/WebPage/index.html)
* Antonio Tomas Lorente Mur - [Website]( https://sites.google.com/view/antonio-lorente-mur/)
* Fadoua Taia-Alaoui
# How to cite?
When using SPyRiT in scientific publications, please cite the following paper:
* G. Beneti-Martin, L Mahieu-Williame, T Baudier, N Ducros, "OpenSpyrit: an Ecosystem for Reproducible Single-Pixel Hyperspectral Imaging," Optics Express, Vol. 31, No. 10, (2023). https://doi.org/10.1364/OE.483937.
When using SPyRiT specifically for the denoised completion network, please cite the following paper:
* A Lorente Mur, P Leclerc, F Peyrin, and N Ducros, "Single-pixel image reconstruction from experimental data using neural networks," Opt. Express 29, 17097-17110 (2021). https://doi.org/10.1364/OE.424228.
# License
This project is licensed under the LGPL-3.0 license - see the [LICENSE.md](LICENSE.md) file for details
# Acknowledgments
* [Jin LI](https://github.com/happyjin/ConvGRU-pytorch) for his implementation of Convolutional Gated Recurrent Units for PyTorch
* [Erik Lindernoren](https://github.com/eriklindernoren/Action-Recognition) for his processing of the UCF-101 Dataset.
Raw data
{
"_id": null,
"home_page": "https://github.com/openspyrit/spyrit",
"name": "spyrit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "tutorial package",
"author": "Antonio Tomas Lorente Mur, Nicolas Ducros, Sebastien Crombez",
"author_email": "Nicolas.Ducros@insa-lyon.fr",
"download_url": "https://files.pythonhosted.org/packages/fe/68/cda083be029aacae21b462f7e056296b3d581726c3a1177fdabe978921bd/spyrit-2.2.0.tar.gz",
"platform": null,
"description": "\n[](https://github.com/openspyrit/spyrit/blob/master/LICENSE.md)\n[](https://pypi.python.org/pypi/spyrit/)\n[](https://spyrit.readthedocs.io/en/master/)\n\n# SPyRiT\nSPyRiT is a [PyTorch](https://pytorch.org/)-based toolbox for deep image reconstruction. While SPyRiT was originally designed for single-pixel image reconstruction, it can solve any linear reconstruction problem.\n\n# Installation\nThe spyrit package is available for Linux, MacOs and Windows. We recommend to use a virtual environment.\n## Linux and MacOs\n(user mode)\n```\npip install spyrit\n```\n(developper mode)\n```\ngit clone https://github.com/openspyrit/spyrit.git\ncd spyrit\npip install -e .\n```\n\n## Windows\nOn Windows you may need to install PyTorch first. It may also be necessary to run the following commands using administrator rights (e.g., starting your Python environment with administrator rights).\n\nAdapt the two examples below to your configuration (see [here](https://pytorch.org/get-started/locally/) for the latest instructions)\n\n(CPU version using `pip`)\n\n```\npip3 install torch torchvision torchaudio\n```\n\n(GPU version using `conda`)\n\n``` shell\nconda install pytorch torchvision torchaudio pytorch-cuda=11.8 -c pytorch -c nvidia\n```\n\nThen, install SPyRiT using `pip`.\n\n## Test\nTo check the installation, run in your python terminal:\n```\nimport spyrit\n```\n\n## Examples\nTo start, check the [documentation tutorials](https://spyrit.readthedocs.io/en/latest/gallery/index.html).\n\nMore advanced reconstruction examples can be found in [spyrit-examples/tutorial](https://github.com/openspyrit/spyrit-examples/tree/master/tutorial). Run advanced tutorial in colab: [](https://colab.research.google.com/github/openspyrit/spyrit-examples/blob/master/tutorial/tuto_core_2d_drunet.ipynb)\n\n\n# API Documentation\nhttps://spyrit.readthedocs.io/\n\n# Contributors (alphabetical order)\n* Juan Abascal - [Website](https://juanabascal78.wixsite.com/juan-abascal-webpage)\n* Thomas Baudier\n* Sebastien Crombez\n* Nicolas Ducros - [Website](https://www.creatis.insa-lyon.fr/~ducros/WebPage/index.html)\n* Antonio Tomas Lorente Mur - [Website]( https://sites.google.com/view/antonio-lorente-mur/)\n* Fadoua Taia-Alaoui\n\n# How to cite?\nWhen using SPyRiT in scientific publications, please cite the following paper:\n\n* G. Beneti-Martin, L Mahieu-Williame, T Baudier, N Ducros, \"OpenSpyrit: an Ecosystem for Reproducible Single-Pixel Hyperspectral Imaging,\" Optics Express, Vol. 31, No. 10, (2023). https://doi.org/10.1364/OE.483937.\n\nWhen using SPyRiT specifically for the denoised completion network, please cite the following paper:\n\n* A Lorente Mur, P Leclerc, F Peyrin, and N Ducros, \"Single-pixel image reconstruction from experimental data using neural networks,\" Opt. Express 29, 17097-17110 (2021). https://doi.org/10.1364/OE.424228.\n\n# License\nThis project is licensed under the LGPL-3.0 license - see the [LICENSE.md](LICENSE.md) file for details\n\n# Acknowledgments\n* [Jin LI](https://github.com/happyjin/ConvGRU-pytorch) for his implementation of Convolutional Gated Recurrent Units for PyTorch\n* [Erik Lindernoren](https://github.com/eriklindernoren/Action-Recognition) for his processing of the UCF-101 Dataset.\n",
"bugtrack_url": null,
"license": "Attribution-ShareAlike 4.0 International",
"summary": "Demo package",
"version": "2.2.0",
"project_urls": {
"Homepage": "https://github.com/openspyrit/spyrit"
},
"split_keywords": [
"tutorial",
"package"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5f422c72e753f8d838ae1b5923686164ca2613ae9171d9059769adbac7ee50b",
"md5": "48659a794bfc655160fded3a6ecfd929",
"sha256": "70c0f3b5da77596b4e4086faa0ed2d126d4420365787a3bfef19ad84866a52be"
},
"downloads": -1,
"filename": "spyrit-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48659a794bfc655160fded3a6ecfd929",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 56084,
"upload_time": "2023-10-10T09:53:02",
"upload_time_iso_8601": "2023-10-10T09:53:02.701158Z",
"url": "https://files.pythonhosted.org/packages/e5/f4/22c72e753f8d838ae1b5923686164ca2613ae9171d9059769adbac7ee50b/spyrit-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe68cda083be029aacae21b462f7e056296b3d581726c3a1177fdabe978921bd",
"md5": "3aff9e4c175f2291ea534f5ff8d35c17",
"sha256": "5692c1bc5153df39e2a221ecb9fb214c42cae51af1d84ccec6055722764b6fda"
},
"downloads": -1,
"filename": "spyrit-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "3aff9e4c175f2291ea534f5ff8d35c17",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 50749,
"upload_time": "2023-10-10T09:53:04",
"upload_time_iso_8601": "2023-10-10T09:53:04.363736Z",
"url": "https://files.pythonhosted.org/packages/fe/68/cda083be029aacae21b462f7e056296b3d581726c3a1177fdabe978921bd/spyrit-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-10 09:53:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openspyrit",
"github_project": "spyrit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "spyrit"
}
JSON
