Skip to content

Commit

Permalink
Refer to documentation in README / improve specs wording
Browse files Browse the repository at this point in the history
  • Loading branch information
tristan0x committed Sep 5, 2017
1 parent 2dfba81 commit 4ca92b9
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 7 deletions.
18 changes: 18 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,21 @@ benchmarks. A benchmark is made of several steps::
2. execution
3. metrics extraction and archiving
4. analytics and monitoring

Status
======

Use-cases and requirements are currently being collected. Take part!

Documentation
=============

Documentation is hosted on `Read the Docs <perfmum.rtfd.io>`__

License
=======

**perfmum** is licensed under the BSD License. See the LICENSE.txt_ file
for more details.

.. _LICENSE: ./LICENSE
15 changes: 8 additions & 7 deletions docs/specifications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,32 +16,33 @@ Use-cases

Micro-benchmarks in CI
----------------------
As a HPC developer, given a C++ library maintained by HPC team, when I
push a Git changes, then continuous integration
As a developer, given a C++ library I maintain, when I
push Git changes, then continuous integration
executes micro-benchmarks of some critical C++ sections of the library.

Micro-benchmarks CMake helpers
------------------------------
As a HPC developer, given a C++ library built with CMake, **perfmum**
As a developer, given a C++ library built with CMake, **perfmum**
provides dedicaded CMake modules to add new micro-benchmarks to the ``test``
target.

Micro-benchmarks monitoring over time
-------------------------------------
As a HPC developer, given a C++ library maintained by HPC team with
As a developer, given a C++ library I maintain with
a micro-benchmark integrated in the continuous integration process, I can
review the history of metrics of this benchmark in a web browser.

Launch coreneuron simulation
----------------------------
As a HPC developer, I can use **perfmum** to describe a coreneuron simulation
from the different build configurations to the runtime parameters. **perfmum**
will take care of the different phases: build, run, and archive results.
will take care of the different phases: build, run, results extraction
and archiving, analytics and monitoring.

Simulations for coreneuron UT
-----------------------------
As a HPC developer, I can describe the different simulations the continuous
integration workflow of coreneuron has to use to validate a pull-request.
As a developer, I can describe the different simulations used by the
coreneuron continuous integration workflow.

Coreneuron integration tests
----------------------------
Expand Down

0 comments on commit 4ca92b9

Please sign in to comment.