Command line interface¶
paper¶
Manage and build paper projects.
usage: paper [-h] [--version]
{init,create,remove,config,build,preprocess,info,clean,analysis}
...
-
-h,--help¶ show this help message and exit
-
--version¶ show program’s version number and exit
paper analysis¶
usage: paper analysis [-h] {create,remove,build,info,clean} ...
-
-h,--help¶ show this help message and exit
paper analysis build¶
usage: paper analysis build [-h] [-p PATH] [-v VERSION] [--all] [-f]
[-t TARGET]
[name [name ...]]
-
name¶ Analysis name
-
-h,--help¶ show this help message and exit
-
-p<path>,--path<path>¶ Path to paper project
-
-v<version>,--version<version>¶ Paper version
-
--all¶ Build all analyses
-
-f,--force¶ Force build analysis
-
-t<target>,--target<target>¶ Analysis targets to build
paper analysis clean¶
usage: paper analysis clean [-h] [-p PATH] [-v VERSION] [--all] [-t TARGET]
[name [name ...]]
-
name¶ Analysis name
-
-h,--help¶ show this help message and exit
-
-p<path>,--path<path>¶ Path to paper project
-
-v<version>,--version<version>¶ Paper version
-
--all¶ Clean all analyses
-
-t<target>,--target<target>¶ Analysis targets to clean
paper analysis create¶
usage: paper analysis create [-h] [-v VERSION] [-c CLONE] [-p PATH] name
-
name¶ Analysis name
-
-h,--help¶ show this help message and exit
-
-v<version>,--version<version>¶ Paper version
-
-c<clone>,--clone<clone>¶ Clone existing analysis
-
-p<path>,--path<path>¶ Path to paper project
paper analysis info¶
usage: paper analysis info [-h] [-v VERSION] name
-
name¶ Analysis name
-
-h,--help¶ show this help message and exit
-
-v<version>,--version<version>¶ Paper version
paper analysis remove¶
usage: paper analysis remove [-h] [--clean] [-v VERSION] [--all] [-p PATH]
[name [name ...]]
-
name¶ Analysis name
-
-h,--help¶ show this help message and exit
-
--clean¶ Remove analysis outputs
-
-v<version>,--version<version>¶ Paper version
-
--all¶ Remove all analyses
-
-p<path>,--path<path>¶ Path to paper project
paper build¶
usage: paper build [-h] [-v VERSION] [-f] [-p PATH] [target [target ...]]
-
target¶ What paper output files to build
-
-h,--help¶ show this help message and exit
-
-v<version>,--version<version>¶ Paper version
-
-f,--force¶ Force build of paper
-
-p<path>,--path<path>¶ Path to paper project
paper clean¶
usage: paper clean [-h] [-v VERSION] [--all] [-p PATH]
-
-h,--help¶ show this help message and exit
-
-v<version>,--version<version>¶ Paper version
-
--all¶ Clean paper and analyses
-
-p<path>,--path<path>¶ Path to paper project
paper config¶
usage: paper config [-h] [-p | -u | -v TARGET]
[--set | --unset | --get | --list | --merged | --edit]
[--path PATH]
[key] [value]
-
key¶ Config option key
-
value¶ Config option value
-
-h,--help¶ show this help message and exit
-
-p,--project¶ Target paper project configuration file
-
-u,--user¶ Target global user configuration file
-
-v<target>,--version<target>¶ Target paper version configuration file
-
--set¶ Set config option
-
--unset¶ Remove config option
-
--get¶ Retrieve config option
-
--list¶ Show config file
-
--merged¶ Show merged config file
-
--edit¶ Open config file in editor
-
--path<path>¶ Path to paper project
paper create¶
Create new paper version.
usage: paper create [-h] [-p PATH] [-c CLONE] [--current] name
-
name¶ Name of new paper version
-
-h,--help¶ show this help message and exit
-
-p<path>,--path<path>¶ Path to paper project
-
-c<clone>,--clone<clone>¶ Clone existing paper version
-
--current¶ Set new paper version as current
paper info¶
usage: paper info [-h] [-v VERSION] [-p PATH]
-
-h,--help¶ show this help message and exit
-
-v<version>,--version<version>¶ Paper version
-
-p<path>,--path<path>¶ Path to paper project
paper init¶
Initialize a new paper project.
usage: paper init [-h] [-v VERSION] [--package PACKAGE] [-n NAME] [-c] [-f]
[--description DESCRIPTION]
path
-
path¶ Parent directory of paper project
-
-h,--help¶ show this help message and exit
-
-v<version>,--version<version>¶ Name of first paper version
-
--package<package>¶ Python package structure
-
-n<name>,--name<name>¶ Name of paper project
-
-c,--create¶ Create path if it does not exist
-
-f,--force¶ Force initialization even if path is not empty
-
--description<description>¶ Paper project description