Metadata-Version: 2.1
Name: runman
Version: 0.2.1
Summary: Mange runs of stochastic simulations
Home-page: https://github.com/AllenCellModeling/runman
Author: David Williams
Author-email: cdavew@alleninstitute.org
License: Allen Institute Software License
Keywords: runman
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Free for non-commercial use
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: cloudpickle
Provides-Extra: all
Requires-Dist: cloudpickle ; extra == 'all'
Requires-Dist: codecov ; extra == 'all'
Requires-Dist: pytest ; extra == 'all'
Requires-Dist: pytest-cov ; extra == 'all'
Requires-Dist: pytest-raises ; extra == 'all'
Requires-Dist: flake8 ; extra == 'all'
Requires-Dist: black ; extra == 'all'
Requires-Dist: pytest-runner ; extra == 'all'
Requires-Dist: bumpversion (>=0.5.3) ; extra == 'all'
Requires-Dist: coverage (>=5.0a4) ; extra == 'all'
Requires-Dist: ipython (>=7.5.0) ; extra == 'all'
Requires-Dist: m2r (>=0.2.1) ; extra == 'all'
Requires-Dist: pytest (>=4.3.0) ; extra == 'all'
Requires-Dist: pytest-cov (==2.6.1) ; extra == 'all'
Requires-Dist: pytest-raises (>=0.10) ; extra == 'all'
Requires-Dist: pytest-runner (>=4.4) ; extra == 'all'
Requires-Dist: Sphinx (>=2.0.0b1) ; extra == 'all'
Requires-Dist: sphinx-rtd-theme (>=0.1.2) ; extra == 'all'
Requires-Dist: tox (>=3.5.2) ; extra == 'all'
Requires-Dist: twine (>=1.13.0) ; extra == 'all'
Requires-Dist: wheel (>=0.33.1) ; extra == 'all'
Provides-Extra: dev
Requires-Dist: bumpversion (>=0.5.3) ; extra == 'dev'
Requires-Dist: coverage (>=5.0a4) ; extra == 'dev'
Requires-Dist: ipython (>=7.5.0) ; extra == 'dev'
Requires-Dist: m2r (>=0.2.1) ; extra == 'dev'
Requires-Dist: pytest (>=4.3.0) ; extra == 'dev'
Requires-Dist: pytest-cov (==2.6.1) ; extra == 'dev'
Requires-Dist: pytest-raises (>=0.10) ; extra == 'dev'
Requires-Dist: pytest-runner (>=4.4) ; extra == 'dev'
Requires-Dist: Sphinx (>=2.0.0b1) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (>=0.1.2) ; extra == 'dev'
Requires-Dist: tox (>=3.5.2) ; extra == 'dev'
Requires-Dist: twine (>=1.13.0) ; extra == 'dev'
Requires-Dist: wheel (>=0.33.1) ; extra == 'dev'
Provides-Extra: setup
Requires-Dist: pytest-runner ; extra == 'setup'
Provides-Extra: test
Requires-Dist: codecov ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-raises ; extra == 'test'
Requires-Dist: flake8 ; extra == 'test'
Requires-Dist: black ; extra == 'test'

# Run Manager

[![Build Status](https://github.com/AllenCellModeling/runman/workflows/Build%20Master/badge.svg)](https://github.com/AllenCellModeling/runman/actions)
[![Documentation](https://github.com/AllenCellModeling/runman/workflows/Documentation/badge.svg)](https://AllenCellModeling.github.io/runman)

Mange runs (mostly of stochastic simulations)

---

## Features
* Register a world, functions to be called on each timestep, and functions that perform logging

## Quick Start
```python
import runman

counter = []
def step(timestep):
    counter.append(timestep)
def log():
    print(counter[-1])
    return counter[-1]

run = runman.Run(assets=[counter, ], 
                 stepfns=[step, ],
                 logfns=[log, ], 
                 loginterval=2)
run.run(10)
```

## Installation

Clone and install or `pip install git+https://github.com/AllenCellModeling/runman.git`

## Documentation
For full package documentation please visit [AllenCellModeling.github.io/runman](https://AllenCellModeling.github.io/runman).


Available under the Allen Institute Software License



