=============
Sphire plugin
=============
This plugin provides a wrapper for some programs of `SPHIRE <https://sphire.mpg.de/>`_ software suite:
- JANNI (Just Another Noise 2 Noise Implementation): a neural network denoising tool
- crYOLO: a fast and accurate particle picking procedure. It's based on convolutional neural networks and utilizes the popular You Only Look Once (YOLO) object detection system.
.. image:: https://img.shields.io/pypi/v/scipion-em-sphire.svg
:target: https://pypi.python.org/pypi/scipion-em-sphire
:alt: PyPI release
.. image:: https://img.shields.io/pypi/l/scipion-em-sphire.svg
:target: https://pypi.python.org/pypi/scipion-em-sphire
:alt: License
.. image:: https://img.shields.io/pypi/pyversions/scipion-em-sphire.svg
:target: https://pypi.python.org/pypi/scipion-em-sphire
:alt: Supported Python versions
.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-em-sphire?server=https%3A%2F%2Fsonarcloud.io
:target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-em-sphire
:alt: SonarCloud quality gate
.. image:: https://img.shields.io/pypi/dm/scipion-em-sphire
:target: https://pypi.python.org/pypi/scipion-em-sphire
:alt: Downloads
Installation
------------
You will need to use 3.0+ version of Scipion to be able to run these protocols. To install the plugin, you have two options:
a) Stable version
It can be installed in user mode via Scipion plugin manager (**Configuration** > **Plugins**) or using the command line:
.. code-block::
scipion installp -p scipion-em-sphire
b) Developer's version
* download repository
.. code-block::
git clone -b devel https://github.com/scipion-em/scipion-em-sphire.git
* install
.. code-block::
scipion installp -p /path/to/scipion-em-sphire --devel
crYOLO software will be installed automatically with the plugin but you can also use an existing installation by providing *CRYOLO_ENV_ACTIVATION* (see below).
**Important:** you need to have conda (miniconda3 or anaconda3) pre-installed to use this program.
To check the installation you can run the plugin's tests:
``scipion test --grep sphire --run``
Configuration variables
-----------------------
**CONDA_ACTIVATION_CMD**: If undefined, it will rely on conda command being in the
PATH (not recommended), which can lead to execution problems mixing scipion
python with conda ones. One example of this could can be seen below but
depending on your conda version and shell you will need something different:
CONDA_ACTIVATION_CMD = eval "$(/extra/miniconda3/bin/conda shell.bash hook)"
**CRYOLO_ENV_ACTIVATION** (default = conda activate cryolo-1.9.7):
Command to activate the crYOLO environment.
**NAPARI_ENV_ACTIVATION** (default = conda activate napari-0.4.17):
Command to activate napari environment (used only for tomo picker viewer).
Downloaded crYOLO and JANNI general models can be found in the following locations:
* ``<SCIPION_HOME>/software/em/cryolo_model-[model_version]``
* ``<SCIPION_HOME>/software/em/cryolo_negstain_model-[model_version]`` (not installed by default)
* ``<SCIPION_HOME>/software/em/janni_model-[model_version]``
Running on CPU
--------------
crYOLO can run on CPU, however this is only recommended for picking protocol and not training.
For that reason the CPU implementation is only available for the *crYOLO-Picking protocol*.
The CPU implementation of crYOLO **is not installed by default**. Therefore you must install the *cryoloCPU-[version]* package in the **Configuration** > **Plugins** >> **scipion-em-sphire** or by running:
``scipion installb cryoloCPU``
The CPU version of crYOLO is installed under a separate conda environment called *cryoloCPU-[version]*. If you already have a cryoloCPU environment pre-installed, then modify the following variable in the Scipion config file:
``CRYOLO_ENV_ACTIVATION_CPU = conda activate envName``
Supported versions
------------------
1.8.5, 1.9.3, 1.9.6, ,1.9.7
Protocols
---------
* import crYOLO training model
* crYOLO picking
* crYOLO tomo picking
* crYOLO training
* JANNI denoising
References
----------
* Wagner, T. et al. SPHIRE-crYOLO is a fast and accurate fully automated particle picker for cryo-EM. Communications Biology 2, (2019).
Raw data
{
"_id": null,
"home_page": "https://github.com/scipion-em/scipion-em-sphire",
"name": "scipion-em-sphire",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "scipion electron-microscopy cryo-em structural-biology image-processing scipion-3.0",
"author": "I2PC, Jose Miguel de La Rosa Trevin, Jorge Jim\u00e9nez",
"author_email": "scipion@cnb.csic.es",
"download_url": "https://files.pythonhosted.org/packages/51/66/7733824208867b9d4002522d3f3ef37a9d5bccf774892564c911757388ba/scipion-em-sphire-3.1.14.tar.gz",
"platform": null,
"description": "=============\nSphire plugin\n=============\n\nThis plugin provides a wrapper for some programs of `SPHIRE <https://sphire.mpg.de/>`_ software suite:\n\n - JANNI (Just Another Noise 2 Noise Implementation): a neural network denoising tool\n - crYOLO: a fast and accurate particle picking procedure. It's based on convolutional neural networks and utilizes the popular You Only Look Once (YOLO) object detection system.\n\n.. image:: https://img.shields.io/pypi/v/scipion-em-sphire.svg\n :target: https://pypi.python.org/pypi/scipion-em-sphire\n :alt: PyPI release\n\n.. image:: https://img.shields.io/pypi/l/scipion-em-sphire.svg\n :target: https://pypi.python.org/pypi/scipion-em-sphire\n :alt: License\n\n.. image:: https://img.shields.io/pypi/pyversions/scipion-em-sphire.svg\n :target: https://pypi.python.org/pypi/scipion-em-sphire\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-em-sphire?server=https%3A%2F%2Fsonarcloud.io\n :target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-em-sphire\n :alt: SonarCloud quality gate\n\n.. image:: https://img.shields.io/pypi/dm/scipion-em-sphire\n :target: https://pypi.python.org/pypi/scipion-em-sphire\n :alt: Downloads\n\n\nInstallation\n------------\n\nYou will need to use 3.0+ version of Scipion to be able to run these protocols. To install the plugin, you have two options:\n\na) Stable version\n\n It can be installed in user mode via Scipion plugin manager (**Configuration** > **Plugins**) or using the command line:\n\n .. code-block::\n\n scipion installp -p scipion-em-sphire\n\nb) Developer's version\n\n * download repository\n\n .. code-block::\n\n git clone -b devel https://github.com/scipion-em/scipion-em-sphire.git\n\n * install\n\n .. code-block::\n\n scipion installp -p /path/to/scipion-em-sphire --devel\n\ncrYOLO software will be installed automatically with the plugin but you can also use an existing installation by providing *CRYOLO_ENV_ACTIVATION* (see below).\n\n**Important:** you need to have conda (miniconda3 or anaconda3) pre-installed to use this program.\n\nTo check the installation you can run the plugin's tests:\n\n``scipion test --grep sphire --run``\n\n\nConfiguration variables\n-----------------------\n\n**CONDA_ACTIVATION_CMD**: If undefined, it will rely on conda command being in the\nPATH (not recommended), which can lead to execution problems mixing scipion\npython with conda ones. One example of this could can be seen below but\ndepending on your conda version and shell you will need something different:\n\nCONDA_ACTIVATION_CMD = eval \"$(/extra/miniconda3/bin/conda shell.bash hook)\"\n\n**CRYOLO_ENV_ACTIVATION** (default = conda activate cryolo-1.9.7):\nCommand to activate the crYOLO environment.\n\n**NAPARI_ENV_ACTIVATION** (default = conda activate napari-0.4.17):\nCommand to activate napari environment (used only for tomo picker viewer).\n\nDownloaded crYOLO and JANNI general models can be found in the following locations:\n\n* ``<SCIPION_HOME>/software/em/cryolo_model-[model_version]``\n* ``<SCIPION_HOME>/software/em/cryolo_negstain_model-[model_version]`` (not installed by default)\n* ``<SCIPION_HOME>/software/em/janni_model-[model_version]``\n\nRunning on CPU\n--------------\n\ncrYOLO can run on CPU, however this is only recommended for picking protocol and not training.\nFor that reason the CPU implementation is only available for the *crYOLO-Picking protocol*.\n\nThe CPU implementation of crYOLO **is not installed by default**. Therefore you must install the *cryoloCPU-[version]* package in the **Configuration** > **Plugins** >> **scipion-em-sphire** or by running:\n\n``scipion installb cryoloCPU``\n\nThe CPU version of crYOLO is installed under a separate conda environment called *cryoloCPU-[version]*. If you already have a cryoloCPU environment pre-installed, then modify the following variable in the Scipion config file:\n\n``CRYOLO_ENV_ACTIVATION_CPU = conda activate envName``\n\n\nSupported versions\n------------------\n\n1.8.5, 1.9.3, 1.9.6, ,1.9.7\n\nProtocols\n---------\n\n * import crYOLO training model\n * crYOLO picking\n * crYOLO tomo picking\n * crYOLO training\n * JANNI denoising\n \nReferences\n----------\n\n * Wagner, T. et al. SPHIRE-crYOLO is a fast and accurate fully automated particle picker for cryo-EM. Communications Biology 2, (2019).",
"bugtrack_url": null,
"license": "",
"summary": "Plugin to use Sphire programs within the Scipion framework",
"version": "3.1.14",
"project_urls": {
"Bug Reports": "https://github.com/scipion-em/scipion-em-sphire/issues",
"Homepage": "https://github.com/scipion-em/scipion-em-sphire",
"Source": "https://github.com/scipion-em/scipion-em-sphire/"
},
"split_keywords": [
"scipion",
"electron-microscopy",
"cryo-em",
"structural-biology",
"image-processing",
"scipion-3.0"
],
"urls": [
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "51667733824208867b9d4002522d3f3ef37a9d5bccf774892564c911757388ba",
"md5": "a3bf9e00eda09668d5b3f0ebbd004086",
"sha256": "312e30b6ca380539429aa9f89260b50b66c4527e9266f2ad4f67e696a8ebc3e8"
},
"downloads": -1,
"filename": "scipion-em-sphire-3.1.14.tar.gz",
"has_sig": false,
"md5_digest": "a3bf9e00eda09668d5b3f0ebbd004086",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 49121,
"upload_time": "2024-02-12T09:31:23",
"upload_time_iso_8601": "2024-02-12T09:31:23.793318Z",
"url": "https://files.pythonhosted.org/packages/51/66/7733824208867b9d4002522d3f3ef37a9d5bccf774892564c911757388ba/scipion-em-sphire-3.1.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-12 09:31:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scipion-em",
"github_project": "scipion-em-sphire",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "scipion-em-sphire"
}
JSON
