scipion-em-dynamo


Namescipion-em-dynamo JSON
Version 3.1.21 PyPI version JSON
download
home_pagehttps://github.com/scipion-em/scipion-em-dynamo
SummaryPlugin to use DYNAMO within the Scipion framework
upload_time2023-11-15 08:38:59
maintainer
docs_urlNone
authorI2PC, Scipion Team
requires_python
license
keywords scipion-3.0 electron-microscopy cryo-em structural-biology image-processing
VCS
bugtrack_url
requirements scipion-em-tomo
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =========================
Scipion plugin for Dynamo
=========================

.. image:: https://img.shields.io/pypi/v/scipion-em-dynamo.svg
        :target: https://pypi.python.org/pypi/scipion-em-dynamo
        :alt: PyPI release

.. image:: https://img.shields.io/pypi/l/scipion-em-dynamo.svg
        :target: https://pypi.python.org/pypi/scipion-em-dynamo
        :alt: License

.. image:: https://img.shields.io/pypi/pyversions/scipion-em-dynamo.svg
        :target: https://pypi.python.org/pypi/scipion-em-dynamo
        :alt: Supported Python versions

.. image:: https://img.shields.io/pypi/dm/scipion-em-dynamo
        :target: https://pypi.python.org/pypi/scipion-em-dynamo
        :alt: Downloads

This plugin allows to use Dynamo_ - an environment for subtomogram averaging cryo-ET data - within the Scipion framework.

============
Installation
============
The plugin can be installed in user (stable) or developer (latest, may be unstable) mode:

**1. User (stable) version:**:

.. code-block::

    scipion3 installp -p scipion-em-dynamo

**2. Developer (latest, may be unstable) version:**:

* Clone the source code repository:

.. code-block::

    git clone https://github.com/scipion-em/scipion-em-dynamo.git

* Move to devel branch:

.. code-block::

    git checkout devel

* Install:

.. code-block::

    scipion3 installp -p local/path/to/scipion-em-dynamo --devel

=========
Protocols
=========
The integrated protocols are:

1. bin tomograms: Reduce the size of a set of tomograms by a binning factor.

2. vectorial picking: Manual vectorial picking using Dynamo dtmslice GUI.

3. subtomogram extraction: Extraction of subtomograms.

4. import subtomograms from Dynamo .tbl files.

5. model workflow: apply a geometry model to a set of meshes, normally the result of the vectorial picking protocol.

6. subtomogram alignment.

=====
Tests
=====

The installation can be checked out running some tests. To list all of them, execute:

.. code-block::

     scipion3 tests --grep dynamo

To run all of them, execute:

.. code-block::

     scipion3 tests --grep dynamo --run

To run a specific test, for example, the tests to check the protocol for averaging subtomograms (the following command
can be copied from the test list displayed when listing the tests, as explained above):

.. code-block::

    scipion3 tests dynamo.tests.test_dynamo_average_subtomos.TestDynamoAverageSubtomograms

========
Tutorial
========

A tutorial with examples about how to use Dynamo within Scipion can be found here_.

==========
References
==========

* `Dynamo: A flexible, user-friendly development tool for subtomogram averaging of cryo-EM data in high-performance computing environments. <https://dx.doi.org/10.1016/j.jsb.2011.12.017>`_
  Daniel Castaño-Díez et al., Journal of Structural Biology, 2012.


===================
Contact information
===================

If you experiment any problem, please contact us here: scipion-users@lists.sourceforge.net or open an issue_.

We'll be pleased to help.

*Scipion Team*

.. _Dynamo: https://wiki.dynamo.biozentrum.unibas.ch/w/index.php/Main_Page
.. _here: https://scipion-em.github.io/docs/release-3.0.0/docs/user/tutorials/tomo/Picking_tutorial_lite/dynamo-tutorial-picking-lite.html#tutorial-picking
.. _issue: https://github.com/scipion-em/scipion-em-dynamo/issues



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/scipion-em/scipion-em-dynamo",
    "name": "scipion-em-dynamo",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "scipion-3.0 electron-microscopy cryo-em structural-biology image-processing",
    "author": "I2PC, Scipion Team",
    "author_email": "scipion@cnb.csic.es",
    "download_url": "https://files.pythonhosted.org/packages/00/41/faa329c6f07ca4d98aa95d301c820cbca09ce89812d971063acdefe3ecdf/scipion-em-dynamo-3.1.21.tar.gz",
    "platform": null,
    "description": "=========================\nScipion plugin for Dynamo\n=========================\n\n.. image:: https://img.shields.io/pypi/v/scipion-em-dynamo.svg\n        :target: https://pypi.python.org/pypi/scipion-em-dynamo\n        :alt: PyPI release\n\n.. image:: https://img.shields.io/pypi/l/scipion-em-dynamo.svg\n        :target: https://pypi.python.org/pypi/scipion-em-dynamo\n        :alt: License\n\n.. image:: https://img.shields.io/pypi/pyversions/scipion-em-dynamo.svg\n        :target: https://pypi.python.org/pypi/scipion-em-dynamo\n        :alt: Supported Python versions\n\n.. image:: https://img.shields.io/pypi/dm/scipion-em-dynamo\n        :target: https://pypi.python.org/pypi/scipion-em-dynamo\n        :alt: Downloads\n\nThis plugin allows to use Dynamo_ - an environment for subtomogram averaging cryo-ET data - within the Scipion framework.\n\n============\nInstallation\n============\nThe plugin can be installed in user (stable) or developer (latest, may be unstable) mode:\n\n**1. User (stable) version:**:\n\n.. code-block::\n\n    scipion3 installp -p scipion-em-dynamo\n\n**2. Developer (latest, may be unstable) version:**:\n\n* Clone the source code repository:\n\n.. code-block::\n\n    git clone https://github.com/scipion-em/scipion-em-dynamo.git\n\n* Move to devel branch:\n\n.. code-block::\n\n    git checkout devel\n\n* Install:\n\n.. code-block::\n\n    scipion3 installp -p local/path/to/scipion-em-dynamo --devel\n\n=========\nProtocols\n=========\nThe integrated protocols are:\n\n1. bin tomograms: Reduce the size of a set of tomograms by a binning factor.\n\n2. vectorial picking: Manual vectorial picking using Dynamo dtmslice GUI.\n\n3. subtomogram extraction: Extraction of subtomograms.\n\n4. import subtomograms from Dynamo .tbl files.\n\n5. model workflow: apply a geometry model to a set of meshes, normally the result of the vectorial picking protocol.\n\n6. subtomogram alignment.\n\n=====\nTests\n=====\n\nThe installation can be checked out running some tests. To list all of them, execute:\n\n.. code-block::\n\n     scipion3 tests --grep dynamo\n\nTo run all of them, execute:\n\n.. code-block::\n\n     scipion3 tests --grep dynamo --run\n\nTo run a specific test, for example, the tests to check the protocol for averaging subtomograms (the following command\ncan be copied from the test list displayed when listing the tests, as explained above):\n\n.. code-block::\n\n    scipion3 tests dynamo.tests.test_dynamo_average_subtomos.TestDynamoAverageSubtomograms\n\n========\nTutorial\n========\n\nA tutorial with examples about how to use Dynamo within Scipion can be found here_.\n\n==========\nReferences\n==========\n\n* `Dynamo: A flexible, user-friendly development tool for subtomogram averaging of cryo-EM data in high-performance computing environments. <https://dx.doi.org/10.1016/j.jsb.2011.12.017>`_\n  Daniel Casta\u00f1o-D\u00edez et al., Journal of Structural Biology, 2012.\n\n\n===================\nContact information\n===================\n\nIf you experiment any problem, please contact us here: scipion-users@lists.sourceforge.net or open an issue_.\n\nWe'll be pleased to help.\n\n*Scipion Team*\n\n.. _Dynamo: https://wiki.dynamo.biozentrum.unibas.ch/w/index.php/Main_Page\n.. _here: https://scipion-em.github.io/docs/release-3.0.0/docs/user/tutorials/tomo/Picking_tutorial_lite/dynamo-tutorial-picking-lite.html#tutorial-picking\n.. _issue: https://github.com/scipion-em/scipion-em-dynamo/issues\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Plugin to use DYNAMO within the Scipion framework",
    "version": "3.1.21",
    "project_urls": {
        "Homepage": "https://github.com/scipion-em/scipion-em-dynamo"
    },
    "split_keywords": [
        "scipion-3.0",
        "electron-microscopy",
        "cryo-em",
        "structural-biology",
        "image-processing"
    ],
    "urls": [
        {
            "comment_text": "scipion-3.0",
            "digests": {
                "blake2b_256": "1fe6b91463c4a9a08b230ec69600d65bea4e319213c933b73cc3a8a1363752f3",
                "md5": "02d423232e9f3d973dc58f4eadbdc269",
                "sha256": "b29856df2c0553d6d7986851af0a5e77ae7adb3644d4fd4279b3ead15d4ef5a0"
            },
            "downloads": -1,
            "filename": "scipion_em_dynamo-3.1.21-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "02d423232e9f3d973dc58f4eadbdc269",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 114669,
            "upload_time": "2023-11-15T08:38:57",
            "upload_time_iso_8601": "2023-11-15T08:38:57.744271Z",
            "url": "https://files.pythonhosted.org/packages/1f/e6/b91463c4a9a08b230ec69600d65bea4e319213c933b73cc3a8a1363752f3/scipion_em_dynamo-3.1.21-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "scipion-3.0",
            "digests": {
                "blake2b_256": "0041faa329c6f07ca4d98aa95d301c820cbca09ce89812d971063acdefe3ecdf",
                "md5": "fc143a531491824c6c804c6b399a3c0b",
                "sha256": "986202e157170b00cf1d134498df9058c8a1e693b23a8e4bce14e0f2ae96f204"
            },
            "downloads": -1,
            "filename": "scipion-em-dynamo-3.1.21.tar.gz",
            "has_sig": false,
            "md5_digest": "fc143a531491824c6c804c6b399a3c0b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 88651,
            "upload_time": "2023-11-15T08:38:59",
            "upload_time_iso_8601": "2023-11-15T08:38:59.987242Z",
            "url": "https://files.pythonhosted.org/packages/00/41/faa329c6f07ca4d98aa95d301c820cbca09ce89812d971063acdefe3ecdf/scipion-em-dynamo-3.1.21.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-15 08:38:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "scipion-em",
    "github_project": "scipion-em-dynamo",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "scipion-em-tomo",
            "specs": []
        }
    ],
    "lcname": "scipion-em-dynamo"
}
        
Elapsed time: 0.13969s