ptyrad.cli.templates

CLI utility functions for setting up fresh project folder, and exporting templates / examples params files

Functions

create_starter_project([project_name, force])	Copies the internal 'demo' folder to a new directory named project_name.
export_examples([dest_dir, force])	Copies only the 'starter/params/examples/' folder locally.
export_params([dest_dir, force])	Copies the entire 'starter/params/' folder (including templates/, examples/, walkthrough/) locally.
export_templates([dest_dir, force])	Copies only the 'starter/params/templates/' folder locally.
export_walkthrough([dest_dir, force])	Copies only the 'starter/params/walkthrough/' folder locally.

ptyrad.cli.templates.create_starter_project(project_name='ptyrad', force=False)

Copies the internal ‘demo’ folder to a new directory named project_name.

Parameters:

• project_name (str)

• force (bool)

ptyrad.cli.templates.export_params(dest_dir='.', force=False)

Copies the entire ‘starter/params/’ folder (including templates/, examples/, walkthrough/) locally.

Parameters:

• dest_dir (str)

• force (bool)

ptyrad.cli.templates.export_templates(dest_dir='.', force=False)

Copies only the ‘starter/params/templates/’ folder locally.

Parameters:

• dest_dir (str)

• force (bool)

ptyrad.cli.templates.export_examples(dest_dir='.', force=False)

Copies only the ‘starter/params/examples/’ folder locally.

Parameters:

• dest_dir (str)

• force (bool)

ptyrad.cli.templates.export_walkthrough(dest_dir='.', force=False)

Copies only the ‘starter/params/walkthrough/’ folder locally.

Parameters:

• dest_dir (str)

• force (bool)