• Language: en

popy create

To help you get started with a new script, we provide a tool called popy create that generates an example of one of the Script File Formats. You do this by opening a Open a PoPy Command Prompt and typing:-

popy create [script_type] my_script.pyml

where [script_type] is one of the script names (fit, gen, tut, and so on.). See Script File Formats for a list of all script types.

Typically, the new script can then be edited using your text editor of choice to suit current requirements or immediately run using popy run. See Creating Example Scripts for more information.

Command line options

Setting up PoPy session for first use.
This may take a minute or so.
usage: popy_create [-h] [-t] [-v {noset,info,debug,warning,error,critical}]
                   [-a] [-c] [-l] [-s] [-o]
                   {tut,gen,fit,comp,sim,tutsum,gensum,fitsum,mtut,mgen,mfit,mcomp,msim,grph,vpc,table,val,merge}
                   script_path

Creates an example PoPy script.

positional arguments:
  {tut,gen,fit,comp,sim,tutsum,gensum,fitsum,mtut,mgen,mfit,mcomp,msim,grph,vpc,table,val,merge}
                        type of script to create
  script_path           Required path to configuration file.

options:
  -h, --help            show this help message and exit
  -t, --timestamp       Optionally included timestamp string in log file name
                        and output folder name.
  -v {noset,info,debug,warning,error,critical}, --verbosity {noset,info,debug,warning,error,critical}
                        verbosity of output in log files
  -a, --all_config      Optionally output all possible config file entries in
                        output script files. If set to false, the default
                        entries with default values are suppressed for the
                        sake of brevity.
  -c, --comment_scripts
                        Optionally add explanatory comments to all entries in
                        output script files.
  -l, --line_breaks     Optionally enforce line breaks in the config file.
                        This increases the length of files, but may improve
                        clarity. If set to False, short dictionary lines are
                        compacted instead using {} notation.
  -s, --spaces          Optionally add more spaces to the output config file
                        for greater clarity, but longer config files. Off by
                        default.
  -o, --overwrite       Optionally overwrite existing output files without
                        asking.
Back to Top