=============
pwperformance
=============
**pwperformance** is a Scipion plugin with tests to measure performance and send benchmarks to a Codespeed server
Plugin installation
-------------------
.. code-block::
git clone https://github.com/scipion-em/scipion-em-pwperformance.git
scipion3 installp -p /path/to/scipion-em-pwperformance --devel
Environment variables
---------------------
Define the following environment vars:
.. code-block::
CODESPEED_URL = Codespeed server URL to send benchmarks to. Defaults to "http://localhost:8000"
CODESPEED_ENV = Environment name. Environment describes your testing PC configuration. Defaults to "unknown"
CODESPEED_PROJECT = This should be the plugin you want to test. Defaults to "pyworkflow"
CODESPEED_BRANCH = Git branch of your project. Defaults to "devel"
CODESPEED_COMMIT = Git commit id of your project. Defaults to "1"
Codespeed server installation
-----------------------------
#. conda create -y -n codespeed python=3.6
#. conda activate codespeed
#. pip3 install pypandoc==1.7.5 setuptools==57.5.0 gunicorn
#. git clone https://github.com/tobami/codespeed
#. cd codespeed
#. pip3 install -e .
#. pip3 install "django<2.2,>=1.11"
#. python manage.py migrate
#. python manage.py createsuperuser
#. python manage.py runserver 8000
#. Go to http://localhost:8000/admin
#. create an environment (your CODESPEED_ENV)
#. create a Github-type project (name = CODESPEED_PROJECT) with a correct url (e.g. https://github.com/scipion-em/scipion-pyworkflow), branch (e.g. "devel" or your own CODESPEED_BRANCH) and tick "Track changes"
#. create a "devel" (or your own CODESPEED_BRANCH) branch
Example run
-----------
Run any of the following plugin tests to save the data on the codespeed server, e.g.:
.. code-block::
scipion3 tests pwperformance.tests.test_profiling_load.TestProfilingLoadGUI
scipion3 tests pwperformance.tests.test_set_performance.TestSetPerformanceSteps
scipion3 tests pwperformance.tests.test_exportsteps.TestExportSteps
Raw data
{
"_id": null,
"home_page": "",
"name": "scipion-em-pwperformance",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "scipion cryoem imageprocessing scipion-3.0",
"author": "Pablo Conesa",
"author_email": "pconesa@cnb.csic.es",
"download_url": "https://files.pythonhosted.org/packages/31/4f/487a0f5b964de4eb663c291ece71af9c71573d83119c88f869085fdfa030/scipion-em-pwperformance-0.0.5.tar.gz",
"platform": null,
"description": "=============\npwperformance\n=============\n\n**pwperformance** is a Scipion plugin with tests to measure performance and send benchmarks to a Codespeed server\n\nPlugin installation\n-------------------\n\n.. code-block::\n\n git clone https://github.com/scipion-em/scipion-em-pwperformance.git\n scipion3 installp -p /path/to/scipion-em-pwperformance --devel\n\nEnvironment variables\n---------------------\n\nDefine the following environment vars:\n\n.. code-block::\n\n CODESPEED_URL = Codespeed server URL to send benchmarks to. Defaults to \"http://localhost:8000\"\n CODESPEED_ENV = Environment name. Environment describes your testing PC configuration. Defaults to \"unknown\"\n CODESPEED_PROJECT = This should be the plugin you want to test. Defaults to \"pyworkflow\"\n CODESPEED_BRANCH = Git branch of your project. Defaults to \"devel\"\n CODESPEED_COMMIT = Git commit id of your project. Defaults to \"1\"\n\nCodespeed server installation\n-----------------------------\n\n #. conda create -y -n codespeed python=3.6\n #. conda activate codespeed\n #. pip3 install pypandoc==1.7.5 setuptools==57.5.0 gunicorn\n #. git clone https://github.com/tobami/codespeed\n #. cd codespeed\n #. pip3 install -e .\n #. pip3 install \"django<2.2,>=1.11\"\n #. python manage.py migrate\n #. python manage.py createsuperuser\n #. python manage.py runserver 8000\n #. Go to http://localhost:8000/admin\n #. create an environment (your CODESPEED_ENV)\n #. create a Github-type project (name = CODESPEED_PROJECT) with a correct url (e.g. https://github.com/scipion-em/scipion-pyworkflow), branch (e.g. \"devel\" or your own CODESPEED_BRANCH) and tick \"Track changes\"\n #. create a \"devel\" (or your own CODESPEED_BRANCH) branch\n\nExample run\n-----------\n\nRun any of the following plugin tests to save the data on the codespeed server, e.g.:\n\n.. code-block::\n\n scipion3 tests pwperformance.tests.test_profiling_load.TestProfilingLoadGUI\n scipion3 tests pwperformance.tests.test_set_performance.TestSetPerformanceSteps\n scipion3 tests pwperformance.tests.test_exportsteps.TestExportSteps",
"bugtrack_url": null,
"license": "",
"summary": "Python module to provide performance analysis tools and storage of the metrics for a further comparison",
"version": "0.0.5",
"project_urls": null,
"split_keywords": [
"scipion",
"cryoem",
"imageprocessing",
"scipion-3.0"
],
"urls": [
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "314f487a0f5b964de4eb663c291ece71af9c71573d83119c88f869085fdfa030",
"md5": "e013a01b26f9f714c6ba94ab8e2d68df",
"sha256": "0017fc7de392f832b88cdc4c0990e1483615c3a78a9285b0143feae198e36a1e"
},
"downloads": -1,
"filename": "scipion-em-pwperformance-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "e013a01b26f9f714c6ba94ab8e2d68df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24731,
"upload_time": "2023-05-11T12:47:02",
"upload_time_iso_8601": "2023-05-11T12:47:02.284911Z",
"url": "https://files.pythonhosted.org/packages/31/4f/487a0f5b964de4eb663c291ece71af9c71573d83119c88f869085fdfa030/scipion-em-pwperformance-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-11 12:47:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "scipion-em-pwperformance"
}
JSON