Skip to content

JAVA Implementation of the FAIR Data Pipeline API

License

LGPL-3.0, GPL-3.0 licenses found

Licenses found

LGPL-3.0
COPYING.LESSER
GPL-3.0
LICENSE
Notifications You must be signed in to change notification settings

FAIRDataPipeline/javaDataPipeline

Repository files navigation

javaDataPipeline

test with reg partial test License: LGPL v3 DOI

Java implementation of the FAIR Data Pipeline API

Documentation can be found on https://www.fairdatapipeline.org/docs/API/Java/

JavaDocs are automatically published on https://www.fairdatapipeline.org/javaDataPipeline/

To use a release version (latest: 1.0.0-rc3) include the following dependency (available from mavenCentral):

group: 'org.fairdatapipeline',
name: 'api',
version: '1.0.0-rc3'

javaSimpleModel

Please have a look at https://github.com/FAIRDataPipeline/javaSimpleModel for a simple example on how to use the javaDataPipeline, including an example of the user written config.yaml, and how to integrate it with the FAIR CLI command line interface.

What does it implement?

  • It reads the config.yaml that is re-written by FAIR CLI (not to be confused with the user written config.yaml)
  • It registers a model Coderun session in the FAIR Data Registry, including all the data inputs and/or outputs, from the model, and its code repository, its config.yaml, and its submission (startup) script.
  • It allows the Coderun session to raise Issues with Object_components, codeRepo, config file, and submission script, and these Issues are registered in the Data Registry.
  • It allows reading and writing of Data_products whose Object contains either 1 whole_object unnamed Object_component (for reading and writing 'external' whole-file file formats).
  • It allows reading and writing of Data_products containing a FAIR Data Pipeline (TOML) Parameter File.
  • It does not yet support HDF5 files.

About

JAVA Implementation of the FAIR Data Pipeline API

Resources

License

LGPL-3.0, GPL-3.0 licenses found

Licenses found

LGPL-3.0
COPYING.LESSER
GPL-3.0
LICENSE

Stars

Watchers

Forks

Packages

 
 
 

Languages