Skip to main content

A tool for automated tracking of computation-based scientific projects

Project description

About Sumatra

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 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.

Sumatra is currently beta code, and should be used with caution and frequent backups of your records.

For documentation, see http://neuralensemble.org/sumatra/

Functionality:

  • launch simulations and analyses, and record various pieces of information, including:

    • the executable (identity, version)

    • the script (identity, version)

    • the parameters

    • the duration (execution time)

    • console output

    • links to all data (whether in files, in a database, etc.) produced by the simulation/analysis

    • the reason for doing the simulation/analysis

    • the outcome of the simulation/analysis

  • allow browsing/searching/visualising the results of previous experiments

  • allow the re-running of previous simulations/analyses with automatic verification that the results are unchanged

  • launch single or batch experiments, serial or parallel

Requirements

Sumatra requires Python version 3.9 or later The web interface requires Django (>= 4.2). Sumatra requires that you keep your own code in a version control system (currently Subversion, Mercurial, Git and Bazaar are supported). If you are already using Bazaar there is nothing else to install. If you are using Subversion you will need to install the pysvn package. If you are using Git, you will need to install git-python bindings, and for Mercurial install hg-api.

Installation

These instructions are for Unix and Mac OS. They may work on Windows as well, but it hasn’t been thoroughly tested.

The easiest way to install is with pip:

$ pip install sumatra[default]

The “default” option installs the most commonly-used features:

  • Git support

  • the local web-based GUI

  • support for remote record stores

Other options are available. For example, to install support for Mercurial and for using a PostgreSQL database as the record store, run:

$ pip install sumatra[default,hg,postgres]

Code status

Unit Test Status Code coverage

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sumatra-0.8.0.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

sumatra-0.8.0-py3-none-any.whl (369.4 kB view details)

Uploaded Python 3

File details

Details for the file sumatra-0.8.0.tar.gz.

File metadata

  • Download URL: sumatra-0.8.0.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for sumatra-0.8.0.tar.gz
Algorithm Hash digest
SHA256 843c52be1747696f766ecefb13ff8eb9b228d94cde3f31f9a102f92852940d79
MD5 aeee9698b91ecb2faa4996ed64968ad6
BLAKE2b-256 adfa5df4f6f7bd952e6329aad2622672d70c5cc9b8d686134f4e78f071e78a33

See more details on using hashes here.

File details

Details for the file sumatra-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: sumatra-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 369.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for sumatra-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 10d548358d34e05c9d98f17d792e6ec979de2540aa4042635315aa531742ee23
MD5 d3e0292cc35cec85ef42e77b3bc12cb0
BLAKE2b-256 543d865ad4ad5822159a4055038adaac64238880818cedb334a40143dd30b953

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page