===============
TomoTwin plugin
===============
This plugin provides a wrapper for `TomoTwin <https://github.com/MPI-Dortmund/tomotwin-cryoet>`_ software: Particle picking in Tomograms using triplet networks and metric learning
.. image:: https://img.shields.io/pypi/v/scipion-em-tomotwin.svg
:target: https://pypi.python.org/pypi/scipion-em-tomotwin
:alt: PyPI release
.. image:: https://img.shields.io/pypi/l/scipion-em-tomotwin.svg
:target: https://pypi.python.org/pypi/scipion-em-tomotwin
:alt: License
.. image:: https://img.shields.io/pypi/pyversions/scipion-em-tomotwin.svg
:target: https://pypi.python.org/pypi/scipion-em-tomotwin
:alt: Supported Python versions
.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-em-tomotwin?server=https%3A%2F%2Fsonarcloud.io
:target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-em-tomotwin
:alt: SonarCloud quality gate
.. image:: https://img.shields.io/pypi/dm/scipion-em-tomotwin
:target: https://pypi.python.org/pypi/scipion-em-tomotwin
: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-tomotwin
b) Developer's version
* download repository
.. code-block::
git clone -b devel https://github.com/scipion-em/scipion-em-tomotwin.git
* install
.. code-block::
scipion installp -p /path/to/scipion-em-tomotwin --devel
TomoTwin software will be installed automatically with the plugin but you can also use an existing installation by providing *TOMOTWIN_ENV_ACTIVATION* (see below).
**Important:** you need to have conda (miniconda3 or anaconda3) pre-installed to use this program.
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)"
*TOMOTWIN_ENV_ACTIVATION* (default = conda activate tomotwin-0.8.0):
Command to activate the TomoTwin environment. Tomotwin uses cuda-11.8, so you might want to activate specific CUDA libs via e.g. `TOMOTWIN_ENV_ACTIVATION = . /etc/profile.d/lmod.sh && module load cuda/11.8 && conda activate tomotwin-0.8.0`
*TOMOTWIN_MODEL* (default = software/em/tomotwin_model-092023/tomotwin_model_p120_092023_loss.pth):
Path to the pre-trained model.
*NAPARI_ENV_ACTIVATION* (default = conda activate napari-0.4.17):
Command to activate the Napari viewer environment.
Verifying
---------
To check the installation, simply run the following Scipion tests:
* ``scipion tests tomotwin.tests.test_protocols_tomotwin.TestTomoTwinRefBased``
* ``scipion tests tomotwin.tests.test_protocols_tomotwin.TestTomoTwinClusterBased``
Supported versions
------------------
0.6.1, 0.7.0, 0.8.0
Protocols
----------
* clustering-based picking (step 1)
* clustering-based picking (step 2)
* create tomo masks
* reference-based picking
References
-----------
1. TomoTwin: Generalized 3D Localization of Macromolecules in Cryo-electron Tomograms with Structural Data Mining. Gavin Rice, Thorsten Wagner, Markus Stabrin, Stefan Raunser. https://www.biorxiv.org/content/10.1101/2022.06.24.497279v1
Raw data
{
"_id": null,
"home_page": "https://github.com/scipion-em/scipion-em-tomotwin",
"name": "scipion-em-tomotwin",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"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/2e/e4/de20063d87a76570f8cf0217b033be7fd79e7aee978e7dca16cc3ed300a1/scipion-em-tomotwin-3.4.tar.gz",
"platform": null,
"description": "===============\nTomoTwin plugin\n===============\n\nThis plugin provides a wrapper for `TomoTwin <https://github.com/MPI-Dortmund/tomotwin-cryoet>`_ software: Particle picking in Tomograms using triplet networks and metric learning\n\n.. image:: https://img.shields.io/pypi/v/scipion-em-tomotwin.svg\n :target: https://pypi.python.org/pypi/scipion-em-tomotwin\n :alt: PyPI release\n\n.. image:: https://img.shields.io/pypi/l/scipion-em-tomotwin.svg\n :target: https://pypi.python.org/pypi/scipion-em-tomotwin\n :alt: License\n\n.. image:: https://img.shields.io/pypi/pyversions/scipion-em-tomotwin.svg\n :target: https://pypi.python.org/pypi/scipion-em-tomotwin\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-em-tomotwin?server=https%3A%2F%2Fsonarcloud.io\n :target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-em-tomotwin\n :alt: SonarCloud quality gate\n\n.. image:: https://img.shields.io/pypi/dm/scipion-em-tomotwin\n :target: https://pypi.python.org/pypi/scipion-em-tomotwin\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-tomotwin\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-tomotwin.git\n\n * install\n\n .. code-block::\n\n scipion installp -p /path/to/scipion-em-tomotwin --devel\n\nTomoTwin software will be installed automatically with the plugin but you can also use an existing installation by providing *TOMOTWIN_ENV_ACTIVATION* (see below).\n\n**Important:** you need to have conda (miniconda3 or anaconda3) pre-installed to use this program.\n\nConfiguration variables\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:\nCONDA_ACTIVATION_CMD = eval \"$(/extra/miniconda3/bin/conda shell.bash hook)\"\n\n*TOMOTWIN_ENV_ACTIVATION* (default = conda activate tomotwin-0.8.0):\nCommand to activate the TomoTwin environment. Tomotwin uses cuda-11.8, so you might want to activate specific CUDA libs via e.g. `TOMOTWIN_ENV_ACTIVATION = . /etc/profile.d/lmod.sh && module load cuda/11.8 && conda activate tomotwin-0.8.0`\n\n*TOMOTWIN_MODEL* (default = software/em/tomotwin_model-092023/tomotwin_model_p120_092023_loss.pth):\nPath to the pre-trained model.\n\n*NAPARI_ENV_ACTIVATION* (default = conda activate napari-0.4.17):\nCommand to activate the Napari viewer environment.\n\nVerifying\n---------\nTo check the installation, simply run the following Scipion tests:\n\n* ``scipion tests tomotwin.tests.test_protocols_tomotwin.TestTomoTwinRefBased``\n* ``scipion tests tomotwin.tests.test_protocols_tomotwin.TestTomoTwinClusterBased``\n\nSupported versions\n------------------\n\n0.6.1, 0.7.0, 0.8.0\n\nProtocols\n----------\n\n* clustering-based picking (step 1)\n* clustering-based picking (step 2)\n* create tomo masks\n* reference-based picking\n\nReferences\n-----------\n\n1. TomoTwin: Generalized 3D Localization of Macromolecules in Cryo-electron Tomograms with Structural Data Mining. Gavin Rice, Thorsten Wagner, Markus Stabrin, Stefan Raunser. https://www.biorxiv.org/content/10.1101/2022.06.24.497279v1\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Plugin to use TomoTwin within the Scipion framework",
"version": "3.4",
"project_urls": {
"Bug Reports": "https://github.com/scipion-em/scipion-em-tomotwin/issues",
"Homepage": "https://github.com/scipion-em/scipion-em-tomotwin",
"Source": "https://github.com/scipion-em/scipion-em-tomotwin/"
},
"split_keywords": [
"scipion",
"electron-microscopy",
"cryo-em",
"structural-biology",
"image-processing",
"scipion-3.0"
],
"urls": [
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "5475357ed0d0ca8a0587bad1d9cebb6ab3fdfb427bee7c496230cab343e48405",
"md5": "9ae5d30ac92b56ec9a143c9e46961d98",
"sha256": "cc1542afca8bb1291b7366ebce5932c5650d744d284b85a2e0dd66cab8d670b5"
},
"downloads": -1,
"filename": "scipion_em_tomotwin-3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ae5d30ac92b56ec9a143c9e46961d98",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 170328,
"upload_time": "2023-12-21T15:29:20",
"upload_time_iso_8601": "2023-12-21T15:29:20.299512Z",
"url": "https://files.pythonhosted.org/packages/54/75/357ed0d0ca8a0587bad1d9cebb6ab3fdfb427bee7c496230cab343e48405/scipion_em_tomotwin-3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "2ee4de20063d87a76570f8cf0217b033be7fd79e7aee978e7dca16cc3ed300a1",
"md5": "e5f8c4bb98c560699be0b9df5632f3a3",
"sha256": "f969f5273d6161954493cf436cde9f430bd6c2592c49e78b50e8e5473103e361"
},
"downloads": -1,
"filename": "scipion-em-tomotwin-3.4.tar.gz",
"has_sig": false,
"md5_digest": "e5f8c4bb98c560699be0b9df5632f3a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 160388,
"upload_time": "2023-12-21T15:29:22",
"upload_time_iso_8601": "2023-12-21T15:29:22.443890Z",
"url": "https://files.pythonhosted.org/packages/2e/e4/de20063d87a76570f8cf0217b033be7fd79e7aee978e7dca16cc3ed300a1/scipion-em-tomotwin-3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-21 15:29:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scipion-em",
"github_project": "scipion-em-tomotwin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "scipion-em-tomotwin"
}
JSON
