SimpleWorkflows
Documentation for SimpleWorkflows.
Build workflows from atomic jobs. Run and monitor them.
This package take inspiration from JobSchedulers.jl
and Dispatcher.jl
(unmaintained).
Please cite this package as:
@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}
}
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")
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
Index
SimpleWorkflows.Jobs.Job
SimpleWorkflows.Thunks.Thunk
SimpleWorkflows.Workflows.Workflow
SimpleWorkflows.Jobs.createdtime
SimpleWorkflows.Jobs.description
SimpleWorkflows.Jobs.elapsed
SimpleWorkflows.Jobs.exitedjobs
SimpleWorkflows.Jobs.exitedjobs
SimpleWorkflows.Jobs.failedjobs
SimpleWorkflows.Jobs.failedjobs
SimpleWorkflows.Jobs.getstatus
SimpleWorkflows.Jobs.getstatus
SimpleWorkflows.Jobs.interrupt!
SimpleWorkflows.Jobs.interruptedjobs
SimpleWorkflows.Jobs.interruptedjobs
SimpleWorkflows.Jobs.isexited
SimpleWorkflows.Jobs.isfailed
SimpleWorkflows.Jobs.isinterrupted
SimpleWorkflows.Jobs.ispending
SimpleWorkflows.Jobs.isrunning
SimpleWorkflows.Jobs.issucceeded
SimpleWorkflows.Jobs.ntimes
SimpleWorkflows.Jobs.pendingjobs
SimpleWorkflows.Jobs.pendingjobs
SimpleWorkflows.Jobs.query
SimpleWorkflows.Jobs.queue
SimpleWorkflows.Jobs.runningjobs
SimpleWorkflows.Jobs.runningjobs
SimpleWorkflows.Jobs.starttime
SimpleWorkflows.Jobs.stoptime
SimpleWorkflows.Jobs.succeededjobs
SimpleWorkflows.Jobs.succeededjobs
SimpleWorkflows.Thunks.getresult
SimpleWorkflows.Thunks.getresult
SimpleWorkflows.Thunks.reify!
SimpleWorkflows.Workflows.:←
SimpleWorkflows.Workflows.:→
SimpleWorkflows.Workflows.:⇶
SimpleWorkflows.Workflows.:⬱
SimpleWorkflows.Workflows.chain
SimpleWorkflows.Workflows.converge
SimpleWorkflows.Workflows.fork
SimpleWorkflows.Workflows.spindle
SimpleWorkflows.Workflows.thread
SimpleWorkflows.run!
SimpleWorkflows.run!