SimpleWorkflows

Documentation for SimpleWorkflows.

Build workflows from jobs. Run, monitor, and get results from them.

This package take inspiration from JobSchedulers.jl and Dispatcher.jl (unmaintained).

@misc{zhang2021textttexpress,
      title={$\texttt{express}$: extensible, high-level workflows for swifter $\textit{ab initio}$ materials modeling},
      author={Qi Zhang and Chaoxuan Gu and Jingyi Zhuang and Renata M. Wentzcovitch},
      year={2021},
      eprint={2109.11724},
      archivePrefix={arXiv},
      primaryClass={physics.comp-ph}
}

See the Index for the complete list of documented functions and types.

The code is hosted on GitHub, with some continuous integration services to test its validity.

This repository is created and maintained by @singularitti. You are very welcome to contribute.

Installation

The package can be installed with the Julia package manager. From the Julia REPL, type ] to enter the Pkg REPL mode and run:

pkg> add SimpleWorkflows

Or, equivalently, via the Pkg API:

julia> import Pkg; Pkg.add("SimpleWorkflows")   Resolving package versions...
    Updating `~/.julia/packages/SimpleWorkflows/h9QYi/docs/build/developers/Project.toml`
  [6a97d125] + SimpleWorkflows v0.18.0
    Updating `~/.julia/packages/SimpleWorkflows/h9QYi/docs/build/developers/Manifest.toml`
  [ec485272] + ArnoldiMethod v0.2.0
⌅ [34da2185] ↓ Compat v4.2.0 ⇒ v3.46.0
  [9a962f9c] + DataAPI v1.10.0
  [a93c6f00] + DataFrames v1.3.4
  [e2d170a0] + DataValueInterfaces v1.0.0
  [59287772] + Formatting v0.4.2
  [86223c79] + Graphs v1.7.2
  [d25df0c9] + Inflate v0.1.3
  [41ab1584] + InvertedIndices v1.1.0
  [82899510] + IteratorInterfaceExtensions v1.0.0
  [1914dd2f] + MacroTools v0.5.9
  [e1d29d7a] + Missings v1.0.2
  [2dfb63ee] + PooledArrays v1.4.2
  [08abe8d2] + PrettyTables v1.3.1
  [189a3867] + Reexport v1.2.2
  [699a6c99] + SimpleTraits v0.9.4
  [6a97d125] + SimpleWorkflows v0.18.0
  [a2af1166] + SortingAlgorithms v1.0.1
  [90137ffa] + StaticArrays v1.5.6
  [1e83bf80] + StaticArraysCore v1.3.0
  [3783bdb8] + TableTraits v1.0.1
  [bd369af6] + Tables v1.7.0
  [8bb1440f] + DelimitedFiles
  [8ba89e20] + Distributed
  [9fa8497b] + Future
  [1a1011a3] + SharedArrays
  [2f01184e] + SparseArrays
  [10745b16] + Statistics
  [8dfed614] + Test
        Info Packages marked with ⌅ have new versions available but cannot be upgraded. To see why use `status --outdated -m`

Documentation

STABLE — documentation of the most recently tagged version.
DEV — documentation of the in-development version.

Project status

The package is tested against, and being developed for, Julia 1.6 and above on Linux, macOS, and Windows.

Questions and contributions

Usage questions can be posted on our discussion page.

Contributions are very welcome, as are feature requests and suggestions. Please open an issue if you encounter any problems. The contributing page has a few guidelines that should be followed when opening pull requests and contributing code.

Manual outline

Library outline

Library