psweep.psweep.prep_batch

Contents

psweep.psweep.prep_batch#

psweep.psweep.prep_batch(params, *, calc_templ_dir='templates/calc', machine_templ_dir='templates/machines', git=False, write_pset=False, **kwds)[source]#

Write files based on templates.

Parameters:

  • params (Sequence[dict]) – See run()

  • calc_templ_dir (str) – Dir with templates.

  • machine_templ_dir (str) – Dir with templates.

  • git (bool) – Use git to commit local changes.

  • write_pset (bool) – Write the input pset to <calc_dir>/<pset_id>/pset.pk.

  • **kwds – Passed to run().

Return type:

DataFrame

Returns:

df – The database build from params.

Contents