PCVS Documentation
==================
Parallel Computing Validation System (PCVS) is a Validation Orchestrator
designed by and for software at scale. Its primary target is HPC applications &
runtimes but can flawlessly address smaller use cases. PCVS can help users to
create their test scenarios and reuse them among multiples implementations, an
high value when it comes to validating Programmation standards (like APIs &
ABIs). No matter the number of programs, benchmarks, languages, or tech
non-regression bases use, PCVS gathers in a single execution, and, with a focus
on interacting with HPC batch managers efficiently, run jobs concurrently to
reduce the time-to-result overall. Through basic YAML-based configuration files,
PCVS handles more than hundreds of thousands of tests and helps developers to
ensure code production is moving forward.
## Quick installation guide
A more detailed guide to install PCVS can be found in the appropriate
documentation, here is a quick overview to set up and test the framework.
# considering python3.7+
$ pip3 install -r requirements.txt
# for dev/testing purposes, use:
$ pip3 install -r requirements-dev.txt
$ pip3 install pcvs
# basic tests:
$ tox
# OR
$ coverage run
## Complete documentation
PCVS documentation is currently in active progress. Feel free to redistribute
comments and/or notes to the dev team about what should be more covered.
Multiple documentation can be generated from this repo:
* the CLI is managed and documented through ``click``. The manpages can be
automatically built with the third-party tool ``click-man`` (not a dep,
should be installed manually). Note that these manpages may not contain more
information than the content of each ``--help`` command.
* The general documentation (readthedocs.io-formatted) through ``sphinx``, able
to generate multiple formats. A built version can be found [here](https://pcvs.readthedocs.io).
## Contributions
A guide about contributing to PCVS can be found in the
[`CONTRIBUTING`](docs/source/contribution.rst) section of the documentation.
## Authors
This work is currently supported by the French Alternative Energies and Atomic
Energy Commission (CEA). For any question and/or remarks, please contact :
* Julien JAEGER <julien.jaeger@cea.fr>
* Julien ADAM <julien.adam@paratools.com>
## Licensing
PCVS is released under the [CeCILL-C Free Software
License.](https://cecill.info/licences/Licence_CeCILL-C_V1-en.txt).
Raw data
{
"_id": null,
"home_page": "https://pcvs.io/",
"name": "pcvs",
"maintainer": "Julien Adam",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "adamj@paratools.com",
"keywords": "validation hpc test-suite",
"author": "Julien Adam",
"author_email": "adamj@paratools.com",
"download_url": "https://files.pythonhosted.org/packages/39/a1/9caf6150304cabcb7de2a4693c77a32e06ca65f1a71ef037d62532fde08b/pcvs-0.7.0.tar.gz",
"platform": null,
"description": "PCVS Documentation\n==================\n\nParallel Computing Validation System (PCVS) is a Validation Orchestrator\ndesigned by and for software at scale. Its primary target is HPC applications &\nruntimes but can flawlessly address smaller use cases. PCVS can help users to\ncreate their test scenarios and reuse them among multiples implementations, an\nhigh value when it comes to validating Programmation standards (like APIs &\nABIs). No matter the number of programs, benchmarks, languages, or tech\nnon-regression bases use, PCVS gathers in a single execution, and, with a focus\non interacting with HPC batch managers efficiently, run jobs concurrently to\nreduce the time-to-result overall. Through basic YAML-based configuration files,\nPCVS handles more than hundreds of thousands of tests and helps developers to\nensure code production is moving forward.\n\n\n## Quick installation guide\n\nA more detailed guide to install PCVS can be found in the appropriate\ndocumentation, here is a quick overview to set up and test the framework.\n\n # considering python3.7+\n $ pip3 install -r requirements.txt\n # for dev/testing purposes, use:\n $ pip3 install -r requirements-dev.txt\n $ pip3 install pcvs\n # basic tests:\n $ tox\n # OR\n $ coverage run\n\n\n## Complete documentation\n\nPCVS documentation is currently in active progress. Feel free to redistribute\ncomments and/or notes to the dev team about what should be more covered.\nMultiple documentation can be generated from this repo:\n\n* the CLI is managed and documented through ``click``. The manpages can be\n automatically built with the third-party tool ``click-man`` (not a dep,\n should be installed manually). Note that these manpages may not contain more\n information than the content of each ``--help`` command.\n* The general documentation (readthedocs.io-formatted) through ``sphinx``, able\n to generate multiple formats. A built version can be found [here](https://pcvs.readthedocs.io).\n\n## Contributions\n\nA guide about contributing to PCVS can be found in the \n[`CONTRIBUTING`](docs/source/contribution.rst) section of the documentation.\n\n## Authors\n\nThis work is currently supported by the French Alternative Energies and Atomic\nEnergy Commission (CEA). For any question and/or remarks, please contact :\n\n* Julien JAEGER <julien.jaeger@cea.fr>\n* Julien ADAM <julien.adam@paratools.com>\n\n## Licensing\n\nPCVS is released under the [CeCILL-C Free Software\nLicense.](https://cecill.info/licences/Licence_CeCILL-C_V1-en.txt).\n",
"bugtrack_url": null,
"license": "CeCILL-C",
"summary": "",
"version": "0.7.0",
"project_urls": {
"Documentation": "https://pcvs.readthedocs.io/",
"Homepage": "https://pcvs.io/",
"Source Code": "https://github.com/cea-hpc/pcvs.git/"
},
"split_keywords": [
"validation",
"hpc",
"test-suite"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f309ec35f7b472826c5f17d461f0455e70ffcb1ddf28dff5430341319024190f",
"md5": "da4326373ee5f62487c6eabaa85a040c",
"sha256": "27b1f06d2f3c0122182fb8543b08068bab3e3513dba8f99b71afa23d7a3f67d1"
},
"downloads": -1,
"filename": "pcvs-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da4326373ee5f62487c6eabaa85a040c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 521578,
"upload_time": "2023-06-09T12:30:00",
"upload_time_iso_8601": "2023-06-09T12:30:00.000367Z",
"url": "https://files.pythonhosted.org/packages/f3/09/ec35f7b472826c5f17d461f0455e70ffcb1ddf28dff5430341319024190f/pcvs-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "39a19caf6150304cabcb7de2a4693c77a32e06ca65f1a71ef037d62532fde08b",
"md5": "9b355dadc3afc92eb2acfb9f48c83ae7",
"sha256": "4b93e7eab7aad4843798d33d9e2f7f53c706daa4d59eee8b56cdfb8ca5c604cb"
},
"downloads": -1,
"filename": "pcvs-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "9b355dadc3afc92eb2acfb9f48c83ae7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 474460,
"upload_time": "2023-06-09T12:30:02",
"upload_time_iso_8601": "2023-06-09T12:30:02.798781Z",
"url": "https://files.pythonhosted.org/packages/39/a1/9caf6150304cabcb7de2a4693c77a32e06ca65f1a71ef037d62532fde08b/pcvs-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-09 12:30:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cea-hpc",
"github_project": "pcvs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "ruamel.yaml",
"specs": []
},
{
"name": "addict",
"specs": []
},
{
"name": "Click",
"specs": [
[
">=",
"8.0"
]
]
},
{
"name": "requests",
"specs": []
},
{
"name": "jsonschema",
"specs": []
},
{
"name": "PrettyTable",
"specs": []
},
{
"name": "flask",
"specs": []
},
{
"name": "sh",
"specs": []
},
{
"name": "pygit2",
"specs": []
}
],
"tox": true,
"lcname": "pcvs"
}
JSON
