Data

Tools

Indexes

Applications

Experiments

Open Source Science

cppdatapipeline

C++ Implementation of the FAIR Data Pipeline API

https://github.com/fairdatapipeline/cppdatapipeline

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.2%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

C++ Implementation of the FAIR Data Pipeline API

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 2
  • Open Issues: 7
  • Releases: 8
Created almost 5 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog License Zenodo

README.md

FAIR Data Pipeline C++ API

FDP C++ API Coverage License: LGPL v3 software-checklist DOI

Contents

Installation

You can build and test the library using CMake, this implementation requires C++11.

It is recomended that you install CURL prior to installation of this API - CURL

Compile the library and tests by running:

$ cmake -Bbuild -DFDPAPI_BUILD_TESTS=ON $ cmake --build build

Important For multi-config compilers such as Visual Studio xcode or ninja the config type needs to be set to Release otherwise the API will not build for example: $ cmake -Bbuild -DFDPAPI_BUILD_TESTS=ON $ cmake --build build --config=Release

The library can be installed system-wide using:

$ cmake --build build --target install

Note that this will require Boost to be installed to your system, or you may need to build a shared library:

$ cmake -B build -DFDPAPI_BUILD_TESTS=ON -DBUILD_SHARED_LIBS=ON

After doing so, the library can be discovered and utilised in other CMake projects using:

find_package(fdpapi) target_link_libraries(my_project PRIVATE fdpapi::fdpapi)

Outline

The main class the user will interact with is DataPipeline which has only the required methods such as link_read etc. This class has a member which is a pointer to an underlying DataPipelineImpl_ class which performs the various procedures required to handle the data. A logger has been used to give as much feedback to the user as possible, the verbosity being handled by a log level argument.

Logging

The environment variable FDP_LOG_LEVEL=[TRACE:DEBUG:INFO:WARN:ERROR:CRITICAL:OFF] can be set to specify the logging output level.

Unit Tests

The unit tests use the local registry, this needs to be running prior to running the tests see: the CLI documentation

Tests can be lauched using the following command:

Unix

$ ./build/bin/fdpapi-tests

Windows

$ build\bin\Release\fdpapi-tests.exe

Owner

  • Name: FAIR Data Pipeline
  • Login: FAIRDataPipeline
  • Kind: organization

GitHub Events

Total
Last Year

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 311
  • Total Committers: 5
  • Avg Commits per committer: 62.2
  • Development Distribution Score (DDS): 0.463
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Ryan J Field R****d 167
Kristian Zarebski k****i@u****k 84
Liam Pattinson l****n@g****m 38
Derek Sandiford d****d@u****k 21
bobturneruk 3****k 1
Committer Domains (Top 20 + Academic)
ukaea.uk: 2

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 20
  • Total pull requests: 54
  • Average time to close issues: 2 months
  • Average time to close pull requests: 12 days
  • Total issue authors: 5
  • Total pull request authors: 5
  • Average comments per issue: 1.6
  • Average comments per pull request: 0.81
  • Merged pull requests: 48
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • RyanJField (5)
  • dezed-ukaea (3)
  • richardreeve (1)
  • bobturneruk (1)
  • kzscisoft (1)
Pull Request Authors
  • RyanJField (20)
  • LiamPattinson (4)
  • dezed-ukaea (3)
  • kzscisoft (1)
  • bobturneruk (1)
Top Labels
Issue Labels
Medium Priority (2) Discussion (2) enhancement (1) High Priority (1)
Pull Request Labels

Dependencies

.github/workflows/docs.yaml actions
  • actions/checkout v2 composite
  • actions/checkout main composite
  • actions/setup-python v2 composite
  • mattnotmitt/doxygen-action v1.9.2 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/fdp_cpp_api.yaml actions
  • actions/cache v2.1.5 composite
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • egor-tensin/setup-gcc v1 composite
  • ilammy/msvc-dev-cmd v1 composite
  • snok/install-poetry v1 composite
.github/workflows/test_with_simple_model.yaml actions
  • actions/checkout v2 composite
  • actions/checkout v3 composite
  • actions/setup-python v2 composite
  • snok/install-poetry v1 composite