C++ utilities for parsing and validation

Overview

ritsuko provides common utilities for parsing and validation throughout the ArtifactDB C++ codebase. This is generally not intended for consumption by external developers, but they are nonetheless free to use it. Functionality includes some convenience functions for HDF5 parsing, validation of compressed VLS arrays, and date/time string checking functions.

Check out the reference documentation for available functions. In addition, the following documents contain explanations on the design decisions used throughout ArtifactDB:

• HDF5 internal organization
• Datatype constraints
• Missing value placeholders
• Compressed variable-length strings

Building projects

CMake with FetchContent

If you're using CMake, you just need to add something like this to your CMakeLists.txt:

include(FetchContent)
 
FetchContent_Declare(
  ritsuko 
  GIT_REPOSITORY https://github.com/ArtifactDB/ritsuko
  GIT_TAG master # or any version of interest
)
 
FetchContent_MakeAvailable(ritsuko)

Then you can link to ritsuko to make the headers available during compilation:

# For executables:
target_link_libraries(myexe ritsuko)
 
# For libaries
target_link_libraries(mylib INTERFACE ritsuko)

CMake with find_package()

You can install the library by cloning a suitable version of this repository and running the following commands:

mkdir build && cd build
cmake .. -DRITSUKO_TESTS=OFF
cmake --build . --target install

Then you can use find_package() as usual:

find_package(artifactdb_ritsuko CONFIG REQUIRED)
target_link_libraries(mylib INTERFACE artifactdb::ritsuko)

Further remarks

This library is named after Ritsuko Akizuki.