======================
Scipion for facilities
======================
+------------------+------------------+
| stable: |stable| | devel: |devel| |
+------------------+------------------+
.. |stable| image:: http://scipion-test.cnb.csic.es:9980/badges/facilities_prod.svg
.. |devel| image:: http://scipion-test.cnb.csic.es:9980/badges/facilities_sdevel.svg
'scipion-em-facilities' plugin allows to use different utils for cryo-EM facilities
(like monitors) within the Scipion framework.
Monitors are used to produce live analysis plots, generate reports or
raise alerts when some problems are detected. A monitor example is the CTF-monitor,
that checks the computed defocus values for each micrograph as they are generated.
CTF-monitor may raise an alert if the defocus values are above or below certain thresholds.
A special case of this monitors is the monitor summary which encapsulates the CTF Monitor,
the system monitor and the movie gain monitor and continuously creates a report.
This module contains protocols and utilities related with monitors.
Please, check the `facilities documentation <https://scipion-em.github.io/docs/docs/facilities/facilities.html>`_
for more details.
Installation
------------
You will need to use `Scipion 3.0 <https://scipion-em.github.io/docs/release-3.0.0/index.html>`_
to be able to run these protocols. If you want to use the summary monitor with grafana
you will need to create the file secrets.cfg in the directory defined by the variable EMFACILITIES_HOME
(see the above mention web site for details).
To install the plugin, you have two options:
a) Stable version
.. code-block::
scipion3 installp -p scipion-em-facilities
b) Developer's version
* 1st. Download repository
.. code-block::
git clone https://github.com/scipion-em/scipion-em-facilities.git /path/to/scipion-em-facilities
* 2nd. Install the plugin
.. code-block::
scipion3 installp -p /path/to/scipion-em-facilities --devel
Testing
-------
To check the installation, simply run the following Scipion test:
.. code-block::
scipion3 test --grep emfacilities --mode modules --run
If ``--run`` is not passed, it only shows the available tests to check.
Raw data
{
"_id": null,
"home_page": "https://scipion-em.github.io/docs/docs/facilities/facilities.html",
"name": "scipion-em-facilities",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "scipion cryoem imageprocessing scipion-3.0",
"author": "J.M. De la Rosa Trevin, Roberto Marabini, David Maluenda",
"author_email": "scipion@cnb.csic.es",
"download_url": "https://files.pythonhosted.org/packages/1e/5d/1b18843873096f1651b4417840f3b492d2784138861c270f8251315dcb18/scipion-em-facilities-3.0.5.tar.gz",
"platform": null,
"description": "======================\nScipion for facilities\n======================\n\n+------------------+------------------+\n| stable: |stable| | devel: |devel| |\n+------------------+------------------+\n\n.. |stable| image:: http://scipion-test.cnb.csic.es:9980/badges/facilities_prod.svg\n.. |devel| image:: http://scipion-test.cnb.csic.es:9980/badges/facilities_sdevel.svg\n\n'scipion-em-facilities' plugin allows to use different utils for cryo-EM facilities\n(like monitors) within the Scipion framework.\n\nMonitors are used to produce live analysis plots, generate reports or\nraise alerts when some problems are detected. A monitor example is the CTF-monitor,\nthat checks the computed defocus values for each micrograph as they are generated.\nCTF-monitor may raise an alert if the defocus values are above or below certain thresholds.\nA special case of this monitors is the monitor summary which encapsulates the CTF Monitor,\nthe system monitor and the movie gain monitor and continuously creates a report.\n\nThis module contains protocols and utilities related with monitors.\n\nPlease, check the `facilities documentation <https://scipion-em.github.io/docs/docs/facilities/facilities.html>`_\nfor more details.\n\n\nInstallation\n------------\n\nYou will need to use `Scipion 3.0 <https://scipion-em.github.io/docs/release-3.0.0/index.html>`_\nto be able to run these protocols. If you want to use the summary monitor with grafana\nyou will need to create the file secrets.cfg in the directory defined by the variable EMFACILITIES_HOME\n(see the above mention web site for details).\n\nTo install the plugin, you have two options:\n\na) Stable version\n\n.. code-block::\n\n scipion3 installp -p scipion-em-facilities\n\nb) Developer's version\n\n * 1st. Download repository\n\n .. code-block::\n\n git clone https://github.com/scipion-em/scipion-em-facilities.git /path/to/scipion-em-facilities\n\n * 2nd. Install the plugin\n\n .. code-block::\n\n scipion3 installp -p /path/to/scipion-em-facilities --devel\n\nTesting\n-------\n\nTo check the installation, simply run the following Scipion test:\n\n.. code-block::\n\n scipion3 test --grep emfacilities --mode modules --run\n\nIf ``--run`` is not passed, it only shows the available tests to check.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Plugin for Cryo-EM facilities to be used within Scipion framework",
"version": "3.0.5",
"project_urls": {
"Homepage": "https://scipion-em.github.io/docs/docs/facilities/facilities.html"
},
"split_keywords": [
"scipion",
"cryoem",
"imageprocessing",
"scipion-3.0"
],
"urls": [
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "624bd4dc7ace93e785d9dbc762ebca3a5dc76bd01c0fbe8a70fbfbff4fa20828",
"md5": "a0fbedaa2cafbf3c8c7c1345aeea5b48",
"sha256": "a5aae61987db2957f61345eaffd220a8ace79da457133307cc945b6347ececfe"
},
"downloads": -1,
"filename": "scipion_em_facilities-3.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0fbedaa2cafbf3c8c7c1345aeea5b48",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 118334,
"upload_time": "2023-08-19T07:34:21",
"upload_time_iso_8601": "2023-08-19T07:34:21.638178Z",
"url": "https://files.pythonhosted.org/packages/62/4b/d4dc7ace93e785d9dbc762ebca3a5dc76bd01c0fbe8a70fbfbff4fa20828/scipion_em_facilities-3.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "1e5d1b18843873096f1651b4417840f3b492d2784138861c270f8251315dcb18",
"md5": "5c2539964d19f8e77606fe69ffe0fce6",
"sha256": "39e02b5566a3973cdaa20134643548fea2d355c0521bbd0ccfa233ab21c5a1a0"
},
"downloads": -1,
"filename": "scipion-em-facilities-3.0.5.tar.gz",
"has_sig": false,
"md5_digest": "5c2539964d19f8e77606fe69ffe0fce6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 97135,
"upload_time": "2023-08-19T07:34:23",
"upload_time_iso_8601": "2023-08-19T07:34:23.575293Z",
"url": "https://files.pythonhosted.org/packages/1e/5d/1b18843873096f1651b4417840f3b492d2784138861c270f8251315dcb18/scipion-em-facilities-3.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-19 07:34:23",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "scipion-em-facilities"
}
JSON