.. image:: https://img.shields.io/pypi/v/scipion-pyworkflow.svg
:target: https://pypi.python.org/pypi/scipion-pyworkflow
:alt: PyPI release
.. image:: https://sonarcloud.io/api/project_badges/measure?project=scipion-em_scipion-pyworkflow&metric=alert_status
:alt: Quality Gate Status
:target: https://sonarcloud.io/summary/new_code?id=scipion-em_scipion-pyworkflow
.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-pyworkflow?server=https%3A%2F%2Fsonarcloud.io
:target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-pyworkflow
:alt: SonarCloud quality gate
.. image:: https://img.shields.io/pypi/l/scipion-pyworkflow.svg
:target: https://pypi.python.org/pypi/scipion-pyworkflow
:alt: License
.. image:: https://img.shields.io/pypi/pyversions/scipion-pyworkflow.svg
:target: https://pypi.python.org/pypi/scipion-pyworkflow
:alt: Supported Python versions
.. image:: https://img.shields.io/pypi/dm/scipion-pyworkflow
:target: https://pypi.python.org/pypi/scipion-pyworkflow
:alt: Downloads
.. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
:alt: Contributor Covenant
:target: https://www.contributor-covenant.org/version/2/0/code_of_conduct/
pyworkflow
==========
**pyworkflow** is a simple workflow platform used in scientific applications. It has been initially developed
within the Scipion framework for image processing in Electron Microscopy.
**pyworkflow** allows you to define a working *Domain* by defining the following group of classes:
* Objects: input/outputs that will be generated by different programs
* Protocols: special type of Objects that have defined input parameters and will produce some output
* Viewers: Entities that provide graphical analysis of results.
* Wizards: Small GUIs that can be develop to help users to select given parameter values.
Development
-----------
To install **pyworkflow** for development purposes, one can do:
.. code-block:: bash
# Create a clean virtual environment
conda create -n scipion python=3.8
conda activate
git clone https://github.com/scipion-em/scipion-pyworkflow.git
cd scipion-pyworkflow
pip install -e .
Running tests
-------------
.. code-block:: bash
conda activate scipion
cd scipion-pyworkflow
export SCIPION_DOMAIN="pyworkflowtests/tests/mock_domain"
python -m unittest discover
# Simple project GUI can be shown after running tests:
python pyworkflow/apps/pw_project.py TestProtocolOutputs
All test projects are located in ~/ScipionUserData/Tests/
API documentation
-----------------
https://scipion-em.github.io/docs/release-3.0.0/api/pyworkflow/pyworkflow.html
Raw data
{
"_id": null,
"home_page": null,
"name": "scipion-pyworkflow-windows",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "cryo-em, electron-microscopy, image-processing, science, scipion, structural-biology, workflows",
"author": null,
"author_email": "\"J.M. De la Rosa Trevin\" <delarosatrevin@scilifelab.se>, Roberto Marabini <roberto@cnb.csic.es>, Grigory Sharov <gsharov@mrc-lmb.cam.ac.uk>, Josue Gomez Blanco <josue.gomez-blanco@mcgill.ca>, Pablo Conesa <pconesa@cnb.csic.es>, Yunior Fonseca Reyna <fonsecareyna@cnb.csic.es>",
"download_url": "https://files.pythonhosted.org/packages/d0/68/8d655ec2f33bde506bda4e84157c9a92f410b1fd1bfac4a91359ee6c0af4/scipion_pyworkflow_windows-0.0.8.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/pypi/v/scipion-pyworkflow.svg\n :target: https://pypi.python.org/pypi/scipion-pyworkflow\n :alt: PyPI release\n\n.. image:: https://sonarcloud.io/api/project_badges/measure?project=scipion-em_scipion-pyworkflow&metric=alert_status\n :alt: Quality Gate Status\n :target: https://sonarcloud.io/summary/new_code?id=scipion-em_scipion-pyworkflow\n\n.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-pyworkflow?server=https%3A%2F%2Fsonarcloud.io\n :target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-pyworkflow\n :alt: SonarCloud quality gate\n\n.. image:: https://img.shields.io/pypi/l/scipion-pyworkflow.svg\n :target: https://pypi.python.org/pypi/scipion-pyworkflow\n :alt: License\n\n.. image:: https://img.shields.io/pypi/pyversions/scipion-pyworkflow.svg\n :target: https://pypi.python.org/pypi/scipion-pyworkflow\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/pypi/dm/scipion-pyworkflow\n :target: https://pypi.python.org/pypi/scipion-pyworkflow\n :alt: Downloads\n\n.. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg\n :alt: Contributor Covenant\n :target: https://www.contributor-covenant.org/version/2/0/code_of_conduct/\n\npyworkflow\n==========\n\n**pyworkflow** is a simple workflow platform used in scientific applications. It has been initially developed\nwithin the Scipion framework for image processing in Electron Microscopy.\n \n**pyworkflow** allows you to define a working *Domain* by defining the following group of classes:\n\n * Objects: input/outputs that will be generated by different programs\n * Protocols: special type of Objects that have defined input parameters and will produce some output\n * Viewers: Entities that provide graphical analysis of results.\n * Wizards: Small GUIs that can be develop to help users to select given parameter values.\n\nDevelopment\n-----------\n\nTo install **pyworkflow** for development purposes, one can do:\n\n.. code-block:: bash\n\n # Create a clean virtual environment\n conda create -n scipion python=3.8\n conda activate\n git clone https://github.com/scipion-em/scipion-pyworkflow.git\n cd scipion-pyworkflow\n pip install -e .\n\nRunning tests\n-------------\n\n.. code-block:: bash\n\n conda activate scipion\n cd scipion-pyworkflow\n export SCIPION_DOMAIN=\"pyworkflowtests/tests/mock_domain\"\n python -m unittest discover\n\n # Simple project GUI can be shown after running tests:\n python pyworkflow/apps/pw_project.py TestProtocolOutputs\n\nAll test projects are located in ~/ScipionUserData/Tests/\n\nAPI documentation\n-----------------\n\nhttps://scipion-em.github.io/docs/release-3.0.0/api/pyworkflow/pyworkflow.html\n",
"bugtrack_url": null,
"license": null,
"summary": "Simple workflow platform used in scientific applications, initially developed within the Scipion framework for image processing in Electron Microscopy. Fork of the project to support windows.",
"version": "0.0.8",
"project_urls": {
"Bug Reports": "https://github.com/scipion-em/scipion-pyworkflow/issues",
"Homepage": "https://github.com/scipion-em/scipion-pyworkflow",
"Source": "https://github.com/scipion-em/scipion-pyworkflow/"
},
"split_keywords": [
"cryo-em",
" electron-microscopy",
" image-processing",
" science",
" scipion",
" structural-biology",
" workflows"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "59bdb1ac0634c6f92209837acff5d5dce584f336ea643a38751ba166ce729b9d",
"md5": "44019f6dec04b68451c1630969fedc11",
"sha256": "b74e7dcb4163fbe54f76e5f650014a961eae4e457be2bfaba286e58992668317"
},
"downloads": -1,
"filename": "scipion_pyworkflow_windows-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "44019f6dec04b68451c1630969fedc11",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 15621,
"upload_time": "2024-10-15T11:58:29",
"upload_time_iso_8601": "2024-10-15T11:58:29.352806Z",
"url": "https://files.pythonhosted.org/packages/59/bd/b1ac0634c6f92209837acff5d5dce584f336ea643a38751ba166ce729b9d/scipion_pyworkflow_windows-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d0688d655ec2f33bde506bda4e84157c9a92f410b1fd1bfac4a91359ee6c0af4",
"md5": "65bd8b2a5b1e06f02b53443f24790b68",
"sha256": "2e3a9708eb348ec46564e6da7f9d57b956f7ac0aa7e30cd7a3b6a46da2947ffc"
},
"downloads": -1,
"filename": "scipion_pyworkflow_windows-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "65bd8b2a5b1e06f02b53443f24790b68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14947,
"upload_time": "2024-10-15T11:58:30",
"upload_time_iso_8601": "2024-10-15T11:58:30.272705Z",
"url": "https://files.pythonhosted.org/packages/d0/68/8d655ec2f33bde506bda4e84157c9a92f410b1fd1bfac4a91359ee6c0af4/scipion_pyworkflow_windows-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-15 11:58:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scipion-em",
"github_project": "scipion-pyworkflow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "scipion-pyworkflow-windows"
}
JSON
