PCVS Documentation

About

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.

PCVS is documented through ReStructuredText. which can be found under the /docs directory. A built version can be found at (https://pcvs.readthedocs.io)

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.

.. code-block:: bash

# considering python3.5+
$ 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:

.. code-block:: bash

$ pip3 install -r requirements-dev.txt
$ make -C docs/source # will list available doc formats
$ make -C docs/source man  # global documentation as man pages (not CLI)
$ make -C docs/source html  # readthedocs-based

Contributions

A guide about contributing to PCVS can be found in the CONTRIBUTING 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

License

PCVS is released under the CeCILL-C Free Software License.