Skip to content

Latest commit

 

History

History
179 lines (112 loc) · 3.85 KB

README.rst

File metadata and controls

179 lines (112 loc) · 3.85 KB

tardigrade_error_tools

Project Description

A collection of tools used for error handling. These tools provide a linked list class which can help a user both understand where an error happened and also help the developer to correct for the errors.

Information

Developers

Dependencies

Executables

  • CMake >= 3.14
  • Doxygen >= 1.8.5

Python Modules (for documentation)

  • Sphinx >= 3.0.4
  • Breathe >= 4.30.0
  • sphinx_rtd_theme >= 0.4.3

For convenience, the minimal Python environment requirements for the documentation build are included in environment.txt. A minimal anaconda environment for building the documentation can be created from an existing anaconda installation with the following commands.

$ conda create --file environment.txt

Building the documentation

Warning

API Health Note: The Sphinx API docs are a work-in-progress. The doxygen API is much more useful

sstelmo

  1. Activate a [W-13 Python Environment](https://xcp-confluence.lanl.gov/display/PYT/The+W-13+Python+3+environment)

    $ sv3r

  2. Create the build directory and move there

    $ cd build/

  3. Run cmake configuration

    $ cmake ..

  4. Build the docs

    $ cmake --build docs

  5. Sphinx HTML Documentation builds to:

    tardigrade_error_tools/build/docs/sphinx/html/index.html

  6. Display docs

    $ firefox docs/sphinx/html/index.html &

  7. While the Sphinx API is still a WIP, try the doxygen API

    $ firefox docs/doxygen/html/index.html &

Build the library

Follow the steps for building the documentation and pick up below.

  1. Build just the library

    $ pwd
/path/to/tardigrade_error_tools/build
$ cmake --build src/cpp

Install the library

Build the entire before performing the installation.

  1. Build the entire project

    $ pwd
/path/to/tardigrade_error_tools/build
$ cmake --build . --target all

  2. Install the library

    $ pwd
/path/to/tardigrade_error_tools/build
$ cmake --install . --prefix path/to/root/install

# Example local user (non-admin) Linux install
$ cmake --install . --prefix /home/$USER/.local

# Example install to conda environment
$ cmake --install . --prefix path/to/conda/environment/

# Example install to W-13 CI/CD conda environment performed by CI/CD institutional account
$ cmake --install . --prefix /projects/aea_compute/release

Building the python interface

A python interface to the tardigrade_error_tools C++ routines is provided. After the libraries have been built, they can be linked so that they can be called with python.

sstelmo

  1. Build the libraries

    $ pwd
/path/to/tardigrade_error_tools/build
$ cmake --build . --target all

  2. Activate a [W-13 Python Environment](https://xcp-confluence.lanl.gov/display/PYT/The+W-13+Python+3+environment)

    $ sv3r

  3. in the src/python directory build the interface using cython

    $ python setup.py build_ext --inplace