package bistro

You can search for identifiers within the package.

in-package search v0.2.0

A library to build and run distributed scientific workflows

Install

Dune Dependency

github.com Readme Edit opam file Versions (2)

Authors

P

Philippe Veber

Maintainers

P

philippe.veber@gmail.com

Sources

v0.5.0.tar.gz

md5=0ccb7c97728c94d17494b150192f6162

sha512=61dbd0ee5b98cd5fb8871d653aef0e440c318e9fbca439c3b0e4f86a32fa03c2a8a4770cd96b929b21b378db6788fa7d4df15935370be5b7b227564a31994998

doc/bistro.engine/Bistro_engine/Db/index.html

Module `Bistro_engine.Db`

A database to cache workflow result and execution traces

It is implemented as a directory in the file system.

type t

An abstract type for databases

type id = string

val init : string -> (t, [ `Msg of string ]) result

init path creates a database located at path path, which can be absolute or relative. If the path already exists, its contents is inspected to see if it looks like a bistro database; if not, a fresh database is created on the filesystem.

Returns an error message if path is occupied with something else than a bistro database.

val init_exn : string -> t

raises Failure

val tmp_dir : t -> string

val cache_dir : t -> string

val stdout_dir : t -> string

val stderr_dir : t -> string

val build_dir : t -> string

val singularity_image_dir : t -> string

val tmp : t -> id -> string

val cache : t -> id -> string

val stdout : t -> id -> string

val stderr : t -> id -> string

val build : t -> id -> string

val singularity_image : t -> Bistro_internals.Command.container_image -> string

val container_image_identifier : 
  Bistro_internals.Command.container_image ->
  string

val fold_cache : t -> init:'a -> f:('a -> string -> 'a) -> 'a

val path : t -> Bistro_internals.Workflow.path -> string

val is_in_cache : t -> Bistro_internals.Workflow.any -> bool