Skip to main content

A wrapper to collect data for ensuring reproducibility.

Project description

Runtime Environment Capture

This project aims to create a lightweight wrapper around scripts/commands in order to capture details about the program being run for later reproducibility.

Supported Runtime Options

  • CLI
  • Shell (bash, zsh, etc)
  • Slurm
  • SGE

Instaling REC

REC supports Linux and MacOS, but is primarily geared towards job launchers that are predominantly available on Linux. That being said, some launchers such as Slurm and SGE are not available on MacOS. If you're using a Mac, this likely doesn't mean much to you, but it's worth mentioning.

Installing using Pip

pip install runtime-environment-capture

Running REC

To run REC, issue the following command:

rec [COMMAND]

By default, REC assumes that you will be running and capturing information about a shell command. The simplest way to run REC would be as follows:

rec echo "Hello World"

This will run the command echo "Hello World" as a shell command and will capture information about that command.

Changing Launcher

To change the desired launcher from recording a command to recording a more complex job, REC accepts a --launcher/-l flag. Using this flag, REC can perform launcher specific capture options for supported launchers. If the job was a Slurm job, REC would launch the job, capture information about the job, and collect information about Slurm itself.

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

runtime-environment-capture-0.2.1.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

runtime_environment_capture-0.2.1-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file runtime-environment-capture-0.2.1.tar.gz.

File metadata

  • Download URL: runtime-environment-capture-0.2.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.11

File hashes

Hashes for runtime-environment-capture-0.2.1.tar.gz
Algorithm Hash digest
SHA256 dcd478583cfe670aa1473774469c47d62d8c910a36a6225b81a7338a86ba6880
MD5 0c940b0919f1e7ffeb036906f74a6430
BLAKE2b-256 f65c6bf815ee43007b33091da4bab34d003897da9cb0331cea2d113607104856

See more details on using hashes here.

File details

Details for the file runtime_environment_capture-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: runtime_environment_capture-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.11

File hashes

Hashes for runtime_environment_capture-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8ce0a13636ea6d6170ae0daac282d72ac1e2ce84fcc1b852f730d23493da1111
MD5 2363697594725d87f61e76c01b011b76
BLAKE2b-256 d44212e88e5ecc786b456eab6c28062296ca16c75f6cbf3f5a8205fe826ea726

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