=============
cisTEM plugin
=============
This plugin provides wrappers for several programs of `cisTEM <https://cistem.org>`_ software suite.
.. image:: https://img.shields.io/pypi/v/scipion-em-cistem.svg
:target: https://pypi.python.org/pypi/scipion-em-cistem
:alt: PyPI release
.. image:: https://img.shields.io/pypi/l/scipion-em-cistem.svg
:target: https://pypi.python.org/pypi/scipion-em-cistem
:alt: License
.. image:: https://img.shields.io/pypi/pyversions/scipion-em-cistem.svg
:target: https://pypi.python.org/pypi/scipion-em-cistem
:alt: Supported Python versions
.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-em-cistem?server=https%3A%2F%2Fsonarcloud.io
:target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-em-cistem
:alt: SonarCloud quality gate
.. image:: https://img.shields.io/pypi/dm/scipion-em-cistem
:target: https://pypi.python.org/pypi/scipion-em-cistem
: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
.. code-block::
scipion installp -p scipion-em-cistem
b) Developer's version
* download repository
.. code-block::
git clone -b devel https://github.com/scipion-em/scipion-em-cistem.git
* install
.. code-block::
scipion installp -p /path/to/scipion-em-cistem --devel
**Important:** Starting from plugin v3.9, the config variables have been renamed. See: `scipion3 config -p cistem`
cisTEM binaries will be installed automatically with the plugin, but you can also link an existing installation.
* Default installation path assumed is ``software/em/cistem-1.0.0-beta``, if you want to change it, set *CISTEM_HOME* in ``scipion.conf`` file pointing to the folder where the cisTEM is installed.
* It's possible to use CTFFIND installed separately from cisTEM by defining *CTFFIND_HOME* variable in ``scipion.conf``. Setting this value will have the priority over Ctffind inside cisTEM.
A complete list of tests can be seen by executing ``scipion test --show --grep cistem``
Supported versions
------------------
* 1.0.0-beta (cistem)
* 4.1.13, 4.1.14 (ctffind4)
* 5.0 (ctffind5)
Licenses
--------
* cistem binaries are distributed under `The Janelia Research Campus Software License 1.2 license <http://license.janelia.org/license/janelia_license_1_2.html>`_
* ctffind4 binaries are distributed under `The Janelia Research Campus Software License 1.1 license <https://www.janelia.org/node/47808>`_
* ctffind5 binaries are distributed under `The Janelia Research Campus Software License 1.2 license <http://license.janelia.org/license/janelia_license_1_2.html>`_
Protocols
---------
* ctffind
* import tomo CTFs
* tilt-series ctffind
* unblur
* find particles
* classify 2D
References
----------
1. Johannes Elferich, Lingli Kong, Ximena Zottig, Nikolaus Grigorieff. (2024) CTFFIND5 provides improved insight into quality, tilt and thickness of TEM samples. bioRxiv 2024.02.26.582023; doi: https://doi.org/10.1101/2024.02.26.582023
2. Timothy Grant and Alexis Rohou and Nikolaus Grigorieff. (2018) cisTEM, user-friendly software for single-particle image processing. eLife 7:e35383.
Raw data
{
"_id": null,
"home_page": "https://github.com/scipion-em/scipion-em-cistem",
"name": "scipion-em-cistem",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "scipion electron-microscopy cryo-em structural-biology image-processing scipion-3.0",
"author": "Grigory Sharov",
"author_email": "sharov.grigory@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4b/f1/2de7c0e3a23879211c1d1e0188c51cfd03484eb89d73d0aa558a97fd12d8/scipion-em-cistem-3.9.tar.gz",
"platform": null,
"description": "=============\ncisTEM plugin\n=============\n\nThis plugin provides wrappers for several programs of `cisTEM <https://cistem.org>`_ software suite.\n\n.. image:: https://img.shields.io/pypi/v/scipion-em-cistem.svg\n :target: https://pypi.python.org/pypi/scipion-em-cistem\n :alt: PyPI release\n\n.. image:: https://img.shields.io/pypi/l/scipion-em-cistem.svg\n :target: https://pypi.python.org/pypi/scipion-em-cistem\n :alt: License\n\n.. image:: https://img.shields.io/pypi/pyversions/scipion-em-cistem.svg\n :target: https://pypi.python.org/pypi/scipion-em-cistem\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-em-cistem?server=https%3A%2F%2Fsonarcloud.io\n :target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-em-cistem\n :alt: SonarCloud quality gate\n\n.. image:: https://img.shields.io/pypi/dm/scipion-em-cistem\n :target: https://pypi.python.org/pypi/scipion-em-cistem\n :alt: Downloads\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.. code-block::\n\n scipion installp -p scipion-em-cistem\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-cistem.git\n\n * install\n\n .. code-block::\n\n scipion installp -p /path/to/scipion-em-cistem --devel\n\n**Important:** Starting from plugin v3.9, the config variables have been renamed. See: `scipion3 config -p cistem`\n\ncisTEM binaries will be installed automatically with the plugin, but you can also link an existing installation.\n\n * Default installation path assumed is ``software/em/cistem-1.0.0-beta``, if you want to change it, set *CISTEM_HOME* in ``scipion.conf`` file pointing to the folder where the cisTEM is installed.\n * It's possible to use CTFFIND installed separately from cisTEM by defining *CTFFIND_HOME* variable in ``scipion.conf``. Setting this value will have the priority over Ctffind inside cisTEM.\n\nA complete list of tests can be seen by executing ``scipion test --show --grep cistem``\n\nSupported versions\n------------------\n\n* 1.0.0-beta (cistem)\n* 4.1.13, 4.1.14 (ctffind4)\n* 5.0 (ctffind5)\n\nLicenses\n--------\n\n* cistem binaries are distributed under `The Janelia Research Campus Software License 1.2 license <http://license.janelia.org/license/janelia_license_1_2.html>`_\n* ctffind4 binaries are distributed under `The Janelia Research Campus Software License 1.1 license <https://www.janelia.org/node/47808>`_\n* ctffind5 binaries are distributed under `The Janelia Research Campus Software License 1.2 license <http://license.janelia.org/license/janelia_license_1_2.html>`_\n\nProtocols\n---------\n\n* ctffind\n* import tomo CTFs\n* tilt-series ctffind\n* unblur\n* find particles\n* classify 2D\n\nReferences\n----------\n\n1. Johannes Elferich, Lingli Kong, Ximena Zottig, Nikolaus Grigorieff. (2024) CTFFIND5 provides improved insight into quality, tilt and thickness of TEM samples. bioRxiv 2024.02.26.582023; doi: https://doi.org/10.1101/2024.02.26.582023\n2. Timothy Grant and Alexis Rohou and Nikolaus Grigorieff. (2018) cisTEM, user-friendly software for single-particle image processing. eLife 7:e35383.\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Plugin to use cisTEM programs within the Scipion framework",
"version": "3.9",
"project_urls": {
"Bug Reports": "https://github.com/scipion-em/scipion-em-cistem/issues",
"Homepage": "https://github.com/scipion-em/scipion-em-cistem",
"Source": "https://github.com/scipion-em/scipion-em-cistem/"
},
"split_keywords": [
"scipion",
"electron-microscopy",
"cryo-em",
"structural-biology",
"image-processing",
"scipion-3.0"
],
"urls": [
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "8991235d68d650f2e8961bad8c1e86ef3dd8ef05dff1f085ecfb1a91df7e34cb",
"md5": "cd72abcbcac1fa19e531ce8a850a1b5c",
"sha256": "bba346ed043be24d45e1a3e3bb3a8255b2183c23b0c86629017acd096949a1e9"
},
"downloads": -1,
"filename": "scipion_em_cistem-3.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd72abcbcac1fa19e531ce8a850a1b5c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 172860,
"upload_time": "2024-04-18T12:36:06",
"upload_time_iso_8601": "2024-04-18T12:36:06.041635Z",
"url": "https://files.pythonhosted.org/packages/89/91/235d68d650f2e8961bad8c1e86ef3dd8ef05dff1f085ecfb1a91df7e34cb/scipion_em_cistem-3.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "4bf12de7c0e3a23879211c1d1e0188c51cfd03484eb89d73d0aa558a97fd12d8",
"md5": "90762aa12411ec0ce2ad2fd6ff873060",
"sha256": "83e833522c10247437877b213ead1a76b54cc32cc8ddb96c29cd9a5f6961c145"
},
"downloads": -1,
"filename": "scipion-em-cistem-3.9.tar.gz",
"has_sig": false,
"md5_digest": "90762aa12411ec0ce2ad2fd6ff873060",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 159596,
"upload_time": "2024-04-18T12:36:08",
"upload_time_iso_8601": "2024-04-18T12:36:08.081723Z",
"url": "https://files.pythonhosted.org/packages/4b/f1/2de7c0e3a23879211c1d1e0188c51cfd03484eb89d73d0aa558a97fd12d8/scipion-em-cistem-3.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 12:36:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scipion-em",
"github_project": "scipion-em-cistem",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "scipion-em-cistem"
}
JSON
