.. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
:width: 200
: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": "https://github.com/scipion-em/scipion-pyworkflow",
"name": "scipion-pyworkflow",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "workflows science electron-microscopy cryo-em structural-biology image-processing scipion",
"author": "J.M. De la Rosa Trevin, Roberto Marabini, Grigory Sharov, Josue Gomez Blanco, Pablo Conesa, Yunior Fonseca Reyna",
"author_email": "delarosatrevin@scilifelab.se, roberto@cnb.csic.es, gsharov@mrc-lmb.cam.ac.uk, josue.gomez-blanco@mcgill.ca, pconesa@cnb.csic.es, fonsecareyna@cnb.csic.es",
"download_url": "https://files.pythonhosted.org/packages/a2/02/ba0ace7240db337fe31e92d8bcd75f20d0d3d17fac7ca22f25749f4f0d0a/scipion-pyworkflow-3.5.0.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg\n :width: 200\n :alt: Contributor Covenant\n :target: https://www.contributor-covenant.org/version/2/0/code_of_conduct/ \n\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": "",
"summary": "Simple workflow platform used in scientific applications, initially developed within the Scipion framework for image processing in Electron Microscopy.",
"version": "3.5.0",
"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": [
"workflows",
"science",
"electron-microscopy",
"cryo-em",
"structural-biology",
"image-processing",
"scipion"
],
"urls": [
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "a202ba0ace7240db337fe31e92d8bcd75f20d0d3d17fac7ca22f25749f4f0d0a",
"md5": "26c75a8ccdbc5d448dfb43f682adda85",
"sha256": "451e1532885642b0e31e7f9f1a0e21579baa9ccb5617a3216f10470e712bb277"
},
"downloads": -1,
"filename": "scipion-pyworkflow-3.5.0.tar.gz",
"has_sig": false,
"md5_digest": "26c75a8ccdbc5d448dfb43f682adda85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1038295,
"upload_time": "2024-03-18T08:34:59",
"upload_time_iso_8601": "2024-03-18T08:34:59.053636Z",
"url": "https://files.pythonhosted.org/packages/a2/02/ba0ace7240db337fe31e92d8bcd75f20d0d3d17fac7ca22f25749f4f0d0a/scipion-pyworkflow-3.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 08:34:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scipion-em",
"github_project": "scipion-pyworkflow",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "bibtexparser",
"specs": [
[
"<=",
"1.2.0"
]
]
},
{
"name": "psutil",
"specs": [
[
"<=",
"5.9.1"
]
]
},
{
"name": "configparser",
"specs": [
[
"<=",
"5.2.0"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"==",
"3.3.4"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"==",
"3.5.2"
]
]
},
{
"name": "numpy",
"specs": [
[
"<=",
"1.23.0"
]
]
},
{
"name": "pillow",
"specs": [
[
"==",
"8.4.0"
]
]
},
{
"name": "pillow",
"specs": [
[
"==",
"9.2.0"
]
]
},
{
"name": "requests",
"specs": [
[
"<=",
"2.28.1"
]
]
},
{
"name": "tkcolorpicker",
"specs": []
},
{
"name": "distro",
"specs": [
[
"<=",
"1.8"
]
]
}
],
"lcname": "scipion-pyworkflow"
}
JSON
