# SDeconv
**SDeconv** is a python framework to develop scientific image deconvolution algorithms. This
library has been developed for microscopy 2D and 3D images, but can be use to any image
deconvolution application.
# System Requirements
## Software Requirements
### OS Requirements
The `SDeconv` development version is tested on *Windows 10*, *MacOS* and *Linux* operating systems.
The developmental version of the package has been tested on the following systems:
- Linux: 20.04.4
- Mac OSX: Mac OS Catalina 10.15.7
- Windows: 10
# install
## Library installation from PyPI
1. Install an [Anaconda](https://www.anaconda.com/download/) distribution of Python -- Choose **Python 3.9** and your operating system. Note you might need to use an anaconda prompt if you did not add anaconda to the path.
2. Open an anaconda prompt / command prompt with `conda` for **python 3** in the path
3. Create a new environment with `conda create --name sdeconv python=3.9`.
4. To activate this new environment, run `conda activate sdeconv`
5. To install the `SDeconv`library, run `python -m pip install sdeconv`.
if you need to update to a new release, use:
~~~sh
python -m pip install sdeconv --upgrade
~~~
## Library installation from source
This installation is for developers or people who want the last features in the ``main`` branch.
1. Install an [Anaconda](https://www.anaconda.com/download/) distribution of Python -- Choose **Python 3.9** and your operating system. Note you might need to use an anaconda prompt if you did not add anaconda to the path.
2. Open an anaconda prompt / command prompt with `conda` for **python 3** in the path
3. Create a new environment with `conda create --name sdeconv python=3.9`.
4. To activate this new environment, run `conda activate sdeconv`
5. Pull the source code from git with `git pull https://github.com/sylvainprigent/sdeconv.git
6. Then install the `SDeconv` library from you local dir with: `python -m pip install -e ./sdeconv`.
## Use SDeconv with napari
The SDeconv library is embedded in a napari plugin that allows using ``SDeconv`` with a graphical interface.
Please refer to the [`SDeconv` napari plugin](https://www.napari-hub.org/plugins/napari-sdeconv) documentation to install and use it.
# SDeconv documentation
The full documentation with tutorial and docstring is available [here](https://sylvainprigent.github.io/sdeconv/)
Raw data
{
"_id": null,
"home_page": "https://github.com/sylvainprigent/sdeconv",
"name": "sdeconv",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Sylvain Prigent",
"author_email": "meriadec.prigent@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6f/f5/1d216d78a391d6cb9e209a3d08e3af468cb6ccdf57e1c7b01b311e732b21/sdeconv-1.0.3.tar.gz",
"platform": null,
"description": "# SDeconv\n\n**SDeconv** is a python framework to develop scientific image deconvolution algorithms. This \nlibrary has been developed for microscopy 2D and 3D images, but can be use to any image \ndeconvolution application.\n\n# System Requirements\n\n## Software Requirements\n\n### OS Requirements\n\nThe `SDeconv` development version is tested on *Windows 10*, *MacOS* and *Linux* operating systems. \nThe developmental version of the package has been tested on the following systems:\n\n- Linux: 20.04.4 \n- Mac OSX: Mac OS Catalina 10.15.7 \n- Windows: 10 \n\n# install\n\n## Library installation from PyPI\n\n1. Install an [Anaconda](https://www.anaconda.com/download/) distribution of Python -- Choose **Python 3.9** and your operating system. Note you might need to use an anaconda prompt if you did not add anaconda to the path.\n2. Open an anaconda prompt / command prompt with `conda` for **python 3** in the path\n3. Create a new environment with `conda create --name sdeconv python=3.9`.\n4. To activate this new environment, run `conda activate sdeconv`\n5. To install the `SDeconv`library, run `python -m pip install sdeconv`. \n\nif you need to update to a new release, use:\n~~~sh\npython -m pip install sdeconv --upgrade\n~~~\n\n## Library installation from source\n\nThis installation is for developers or people who want the last features in the ``main`` branch.\n\n1. Install an [Anaconda](https://www.anaconda.com/download/) distribution of Python -- Choose **Python 3.9** and your operating system. Note you might need to use an anaconda prompt if you did not add anaconda to the path.\n2. Open an anaconda prompt / command prompt with `conda` for **python 3** in the path\n3. Create a new environment with `conda create --name sdeconv python=3.9`.\n4. To activate this new environment, run `conda activate sdeconv`\n5. Pull the source code from git with `git pull https://github.com/sylvainprigent/sdeconv.git \n6. Then install the `SDeconv` library from you local dir with: `python -m pip install -e ./sdeconv`. \n\n## Use SDeconv with napari\n\nThe SDeconv library is embedded in a napari plugin that allows using ``SDeconv`` with a graphical interface.\nPlease refer to the [`SDeconv` napari plugin](https://www.napari-hub.org/plugins/napari-sdeconv) documentation to install and use it.\n\n# SDeconv documentation\n\nThe full documentation with tutorial and docstring is available [here](https://sylvainprigent.github.io/sdeconv/)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "Implementation of 2D and 3D scientific image deconvolution",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/sylvainprigent/sdeconv"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dcab0680ba71d2de07959f05020368473f6f25b8b43b637f66c98fc41d995cb3",
"md5": "b1b140ccfc0f53ab24797bf8d1bcb439",
"sha256": "66f8489d5cfe55a22254b5110132b25f9cd0e0e135e39cbd8e6b5c8cea445b15"
},
"downloads": -1,
"filename": "sdeconv-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b1b140ccfc0f53ab24797bf8d1bcb439",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 33959724,
"upload_time": "2024-08-23T16:37:09",
"upload_time_iso_8601": "2024-08-23T16:37:09.073709Z",
"url": "https://files.pythonhosted.org/packages/dc/ab/0680ba71d2de07959f05020368473f6f25b8b43b637f66c98fc41d995cb3/sdeconv-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ff51d216d78a391d6cb9e209a3d08e3af468cb6ccdf57e1c7b01b311e732b21",
"md5": "40f18f343b8f655aabb5ccb742c409b0",
"sha256": "64f6a0201086680e894dcce1112986bc2a5f5a261eab60980e314e900c89ef44"
},
"downloads": -1,
"filename": "sdeconv-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "40f18f343b8f655aabb5ccb742c409b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 33938246,
"upload_time": "2024-08-23T16:37:12",
"upload_time_iso_8601": "2024-08-23T16:37:12.254898Z",
"url": "https://files.pythonhosted.org/packages/6f/f5/1d216d78a391d6cb9e209a3d08e3af468cb6ccdf57e1c7b01b311e732b21/sdeconv-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-23 16:37:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sylvainprigent",
"github_project": "sdeconv",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "sdeconv"
}
JSON
