Sumatra: automated tracking of scientific computations¶
Sumatra is a tool for managing and tracking projects based on numerical simulation and/or analysis, with the aim of supporting reproducible research. It can be thought of as an automated electronic lab notebook for computational projects.
It consists of:
- a command-line interface, smt, for launching simulations/analyses with automatic recording of information about the experiment, annotating these records, linking to data files, etc.
- a web interface with a built-in web-server, smtweb, for browsing and annotating simulation/analysis results.
- a LaTeX package and Sphinx extension for including Sumatra-tracked figures and links to provenance information in papers and other documents.
- a Python API, on which smt and smtweb are based, that can be used in your own scripts in place of using smt, or could be integrated into a GUI-based application.
Table of Contents¶
- Getting started
- Managing a research project with Sumatra
- Using the web interface
- Parameter files
- Input and output data
- Parallel computations
- Reproducible publications: including and linking to provenance information in documents
- Exporting and reporting
- Using the Sumatra API within your own scripts
- Record stores
- Upgrading your projects
- Extending Sumatra with plug-ins
- Graphical user interfaces
- smt command reference
- Developers’ guide
- API reference
- Frequently asked questions
- Getting support
- Release notes
- Authors and contributors