Skip to main content

A simple Python-based automation framework.

Project description

automan: a simple automation framework

CI Status Coverage Status Documentation Status

This framework allows you to automate your computational pipelines. automan is open source and distributed under the terms of the 3-clause BSD license.

Features

It is designed to automate the drudge work of managing many numerical simulations. As an automation framework it does the following:

  • helps you organize your simulations.

  • helps you orchestrate running simulations and then post-processing the results from these.

  • helps you reuse code for the post processing of your simulation data.

  • execute all your simulations and post-processing with one command.

  • optionally distribute your simulations among other computers on your network.

This greatly facilitates reproducibility. Automan is written in pure Python and is easy to install.

Installation

You should be able to install automan using pip as:

$ pip install automan

If you want to run on the bleeding edge, you may also clone this repository, change directory into the created directory and run either:

$ python setup.py install

or:

$ python setup.py develop

Documentation

Documentation for this project is available at https://automan.rtfd.io

There is a paper on automan that motivates and describes the software:

  • Prabhu Ramachandran, “automan: A Python-Based Automation Framework for Numerical Computing,” in Computing in Science & Engineering, vol. 20, no. 5, pp. 81-97, 2018. doi:10.1109/MCSE.2018.05329818

A draft of this paper is available here: https://arxiv.org/abs/1712.04786

There are more than ten research publications that use automan to automate the entire paper. To see complete examples of these research publications using this framework, see the following:

The README.rst in these repositories will document how to set everything up. The automation script will typically be called automate.py.

A simpler example project which uses automan is here: https://github.com/mesnardo/automan-example

The package name

The name automan comes from an old serial with the same name. Most other names were taken on pypi.

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

automan-0.6.tar.gz (57.9 kB view details)

Uploaded Source

Built Distribution

automan-0.6-py3-none-any.whl (39.1 kB view details)

Uploaded Python 3

File details

Details for the file automan-0.6.tar.gz.

File metadata

  • Download URL: automan-0.6.tar.gz
  • Upload date:
  • Size: 57.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.2

File hashes

Hashes for automan-0.6.tar.gz
Algorithm Hash digest
SHA256 47f6d478011e7abf08188fdf8889d93a9fcfbd7e667652d1193a70b39f92a053
MD5 a6f24908ad93a82658f246dce2c5de96
BLAKE2b-256 f6c66fb9b3b587917e14f03465ab7cfcc5fd0e05076588f9c6f62dc422891830

See more details on using hashes here.

File details

Details for the file automan-0.6-py3-none-any.whl.

File metadata

  • Download URL: automan-0.6-py3-none-any.whl
  • Upload date:
  • Size: 39.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.2

File hashes

Hashes for automan-0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b13f7b02cfebe541d30b4af52ab6904e100a0693f7f3f07718c853f4752e891c
MD5 b50f601106f812e1077d5d4023a49dca
BLAKE2b-256 9aa94e4b7c918e21a4986d7cd54bf1ea1bd1d3be79b32ce48446359cdb0203b4

See more details on using hashes here.

Supported by

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