==============
AreTomo plugin
==============
This plugin provides a wrapper for `AreTomo <https://github.com/czimaginginstitute/AreTomo2>`_ program.
.. image:: https://img.shields.io/pypi/v/scipion-em-aretomo.svg
:target: https://pypi.python.org/pypi/scipion-em-aretomo
:alt: PyPI release
.. image:: https://img.shields.io/pypi/l/scipion-em-aretomo.svg
:target: https://pypi.python.org/pypi/scipion-em-aretomo
:alt: License
.. image:: https://img.shields.io/pypi/pyversions/scipion-em-aretomo.svg
:target: https://pypi.python.org/pypi/scipion-em-aretomo
:alt: Supported Python versions
.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-em-aretomo?server=https%3A%2F%2Fsonarcloud.io
:target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-em-aretomo
:alt: SonarCloud quality gate
.. image:: https://img.shields.io/pypi/dm/scipion-em-aretomo
:target: https://pypi.python.org/pypi/scipion-em-aretomo
: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-aretomo
b) Developer's version
* download repository
.. code-block::
git clone -b devel https://github.com/scipion-em/scipion-em-aretomo.git
* install
.. code-block::
scipion installp -p /path/to/scipion-em-aretomo --devel
* AreTomo binaries will be installed automatically with the plugin, but you can also link an existing installation.
* Default installation path assumed is ``software/em/aretomo2-1.0.0``, if you want to change it, set *ARETOMO_HOME* in ``scipion.conf`` file to the folder where the AreTomo is installed.
* Depending on your CUDA version this plugin will guess the right default binary from ``AreTomo2_1.0.0_CudaXY`` (X is for cuda major version, Y for the minor). You can always set a different one by explicitly setting ARETOMO_BIN variable.
* If you need to use CUDA different from the one used during Scipion installation (defined by CUDA_LIB), you can add *ARETOMO_CUDA_LIB* variable to the config file. Various binaries can be downloaded from the official website.
To check the installation, simply run the following Scipion test:
``scipion test aretomo.tests.test_protocols_aretomo.TestAreTomo``
Licensing
---------
AreTomo2 binaries are available under BSD-3 license
Supported versions
------------------
aretomo2: 1.0.0, 1.1.2, 1.1.3
aretomo: 1.3.4
Protocols
---------
* tilt-series align and reconstruct
Detailed manual can be found in ``software/em/aretomo2-1.0.0/bin/AreTomo2Manual_1.0.0_10-26-2023.pdf``
References
----------
* AreTomo: An integrated software package for automated marker-free, motion-corrected cryo-electron tomographic alignment and reconstruction. Shawn Zheng, Georg Wolff, Garrett Greenan, Zhen Chen, Frank G. A. Faas, Montserrat Bárcena, Abraham J. Koster, Yifan Cheng, David Agard. JSB vol. 6, 2022, 100068.
Raw data
{
"_id": null,
"home_page": "https://github.com/scipion-em/scipion-em-aretomo",
"name": "scipion-em-aretomo",
"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/5d/e6/a278d33ff1436e520cdee6017c01c50e8d556f4bb0027ece6a25c75d9ba1/scipion-em-aretomo-3.9.5.tar.gz",
"platform": null,
"description": "==============\nAreTomo plugin\n==============\n\nThis plugin provides a wrapper for `AreTomo <https://github.com/czimaginginstitute/AreTomo2>`_ program.\n\n.. image:: https://img.shields.io/pypi/v/scipion-em-aretomo.svg\n :target: https://pypi.python.org/pypi/scipion-em-aretomo\n :alt: PyPI release\n\n.. image:: https://img.shields.io/pypi/l/scipion-em-aretomo.svg\n :target: https://pypi.python.org/pypi/scipion-em-aretomo\n :alt: License\n\n.. image:: https://img.shields.io/pypi/pyversions/scipion-em-aretomo.svg\n :target: https://pypi.python.org/pypi/scipion-em-aretomo\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-em-aretomo?server=https%3A%2F%2Fsonarcloud.io\n :target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-em-aretomo\n :alt: SonarCloud quality gate\n\n.. image:: https://img.shields.io/pypi/dm/scipion-em-aretomo\n :target: https://pypi.python.org/pypi/scipion-em-aretomo\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-aretomo\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-aretomo.git\n\n * install\n\n .. code-block::\n\n scipion installp -p /path/to/scipion-em-aretomo --devel\n\n* AreTomo binaries will be installed automatically with the plugin, but you can also link an existing installation.\n* Default installation path assumed is ``software/em/aretomo2-1.0.0``, if you want to change it, set *ARETOMO_HOME* in ``scipion.conf`` file to the folder where the AreTomo is installed.\n* Depending on your CUDA version this plugin will guess the right default binary from ``AreTomo2_1.0.0_CudaXY`` (X is for cuda major version, Y for the minor). You can always set a different one by explicitly setting ARETOMO_BIN variable.\n* If you need to use CUDA different from the one used during Scipion installation (defined by CUDA_LIB), you can add *ARETOMO_CUDA_LIB* variable to the config file. Various binaries can be downloaded from the official website.\n\nTo check the installation, simply run the following Scipion test:\n\n``scipion test aretomo.tests.test_protocols_aretomo.TestAreTomo``\n\nLicensing\n---------\n\nAreTomo2 binaries are available under BSD-3 license\n\nSupported versions\n------------------\n\naretomo2: 1.0.0, 1.1.2, 1.1.3\naretomo: 1.3.4\n\nProtocols\n---------\n\n * tilt-series align and reconstruct\n\nDetailed manual can be found in ``software/em/aretomo2-1.0.0/bin/AreTomo2Manual_1.0.0_10-26-2023.pdf``\n\nReferences\n----------\n\n * AreTomo: An integrated software package for automated marker-free, motion-corrected cryo-electron tomographic alignment and reconstruction. Shawn Zheng, Georg Wolff, Garrett Greenan, Zhen Chen, Frank G. A. Faas, Montserrat B\u00e1rcena, Abraham J. Koster, Yifan Cheng, David Agard. JSB vol. 6, 2022, 100068.\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Plugin to use AreTomo program within the Scipion framework",
"version": "3.9.5",
"project_urls": {
"Bug Reports": "https://github.com/scipion-em/scipion-em-aretomo/issues",
"Homepage": "https://github.com/scipion-em/scipion-em-aretomo",
"Source": "https://github.com/scipion-em/scipion-em-aretomo/"
},
"split_keywords": [
"scipion",
"electron-microscopy",
"cryo-em",
"structural-biology",
"image-processing",
"scipion-3.0"
],
"urls": [
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "0615f8444768533a8a498c76768c70094e7d69681512fd7d7ea43c9d2fbe4606",
"md5": "cd492b57c3c971c5727956c9eed01994",
"sha256": "52a43437132962815151104e6c02e1572c6a36a035af7528ba7f3dbaefa0d0d7"
},
"downloads": -1,
"filename": "scipion_em_aretomo-3.9.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd492b57c3c971c5727956c9eed01994",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 39750,
"upload_time": "2024-10-07T15:25:17",
"upload_time_iso_8601": "2024-10-07T15:25:17.938895Z",
"url": "https://files.pythonhosted.org/packages/06/15/f8444768533a8a498c76768c70094e7d69681512fd7d7ea43c9d2fbe4606/scipion_em_aretomo-3.9.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "5de6a278d33ff1436e520cdee6017c01c50e8d556f4bb0027ece6a25c75d9ba1",
"md5": "2b72e65200465d10e866d49816fc0ce4",
"sha256": "2404a59c01f89ba8bd1ba858ebc33c32c3e0ddfffe8b68001105f28a27c2ae54"
},
"downloads": -1,
"filename": "scipion-em-aretomo-3.9.5.tar.gz",
"has_sig": false,
"md5_digest": "2b72e65200465d10e866d49816fc0ce4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38916,
"upload_time": "2024-10-07T15:25:19",
"upload_time_iso_8601": "2024-10-07T15:25:19.577096Z",
"url": "https://files.pythonhosted.org/packages/5d/e6/a278d33ff1436e520cdee6017c01c50e8d556f4bb0027ece6a25c75d9ba1/scipion-em-aretomo-3.9.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 15:25:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scipion-em",
"github_project": "scipion-em-aretomo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "scipion-em",
"specs": [
[
">=",
"3.5.0"
]
]
},
{
"name": "scipion-em-tomo",
"specs": [
[
">=",
"3.7.2"
]
]
},
{
"name": "scipion-pyworkflow",
"specs": [
[
">=",
"3.0.30"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.23.0"
]
]
}
],
"lcname": "scipion-em-aretomo"
}
JSON
