From db56708f10b4fb54c3a7697cbf391501f61673b2 Mon Sep 17 00:00:00 2001 From: Benjamin Alan Weaver Date: Sat, 4 Jun 2016 15:45:59 -0400 Subject: [PATCH] preparing for coverage checks --- .coveragerc | 25 +++++++++++++++++++++++++ doc/index.rst | 9 +++++++++ 2 files changed, 34 insertions(+) create mode 100644 .coveragerc diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..6a47fa3 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,25 @@ +[run] +source = hpsspy +omit = + hpsspy/_version.py + hpsspy/conftest* + hpsspy/cython_version* + hpsspy/setup_package* + hpsspy/*/setup_package* + hpsspy/*/*/setup_package* + hpsspy/test/* + +[report] +exclude_lines = + # Have to re-enable the standard pragma + pragma: no cover + + # Don't complain about packages we have installed + except ImportError + + # Don't complain if tests don't hit assertions + raise AssertionError + raise NotImplementedError + + # Don't complain about script hooks + def main\(.*\): diff --git a/doc/index.rst b/doc/index.rst index 7a869c8..9fec338 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -18,6 +18,15 @@ system at NERSC_. It is currently being developed on GitHub_. .. _NERSC: http://www.nersc.gov .. _GitHub: https://github.com/weaverba137/hpsspy +Requirements +++++++++++++ + +Hpsspy assumes that the HPSS utilities `hsi and htar`_ are installed. You may +need a NERSC account to download and install these utilities. + +.. _`hsi and htar`: https://www.nersc.gov/users/data-and-file-systems/hpss/storing-and-retrieving-data/software-downloads/ + + Contents ++++++++