Metadata-Version: 2.1
Name: scipion-em-aretomo
Version: 3.11.2
Summary: Plugin to use aretomo within the Scipion framework
Author-email: Scipion Team <scipion@cnb.csic.es>
License: GNU General Public License v3 (GPLv3)
Project-URL: Homepage, https://github.com/scipion-em/scipion-em-aretomo
Project-URL: Issues, https://github.com/scipion-em/scipion-em-aretomo/issues
Keywords: scipion,cryoem,cryoet,imageprocessing,scipion-3.0
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: scipion-pyworkflow>=3.11.6
Requires-Dist: scipion-em-tomo>=3.11.3
Requires-Dist: numpy>=1.23.0

==============
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.1.3``, 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.1.3_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``

Licensing
---------

AreTomo2 binaries are available under BSD-3 license

Supported versions
------------------

aretomo2: 1.1.3

Protocols
---------

    * tilt-series align and reconstruct

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.
