Welcome to the psweep docs. We hope that you’ll soon loop like us!

• Manual
  • About
  • Getting started
  • Concepts
  • Naming of database fields
  • Building parameter grids
  • The database
  • Special database fields and repeated runs
  • Best practices
  • Running on (HPC) compute infrastructure
  • Special topics
  • Scope and related projects

API

• API Reference

Install

$ pip install psweep

Dev install of this repo:

$ pip install -e .

To install testing tools, use

$ pip install -e ".[test]"

To install docs tools, use

$ pip install -e ".[doc]"

To also install dask tools which we support (dask.distributed Client) but are not hard dependencies, use

$ pip install -e ".[dask]"
# or to install test and dask deps
##$ pip install -e ".[test,dask]"

See also elcorto/samplepkg.

Tests

# Run in parallel, e.g. use 4 cores
$ pytest -vx -n4

Legal

The package and all its docs are created by Steve Schmerler under BSD 3-Clause license. The psweep logo is created using https://www.textstudio.co.