tp.cli package¶
Module contents¶
Provides a command-line interface.
Submodules¶
tp.cli.cli module¶
Provides a command line interface.
tp.cli.options module¶
Provides groups of options to streamline the CLI
-
tp.cli.options.adminsitrative_options(f)[source]¶ Help and version options.
Allows -h for help (click-nonstandard).
- --help, -h
show help and exit
- --version
show version and exit
-
tp.cli.options.axes_limit_function(multiple=False, c=False)[source]¶ Function for creating axes limit options.
- Parameters
multiple (bool, optional) – allow multiple limits. Default: False.
c (bool, optional) – include colour limits. Default: False.
- Returns
axes limit options decorator.
- Return type
decorator
-
tp.cli.options.direction_function(multiple=False)[source]¶ Function to create direction options.
- Parameters
multiple (bool, optional) – whether to allow multiple directions. Default: False.
- Returns
direction option decorator.
- Return type
decorator
-
tp.cli.options.doping_function(multiple=False)[source]¶ Function to create doping options.
- Parameters
multiple (bool, optional) – whether to allow multiple concentrations. Default: False.
- Returns
carrier concentration option decorator.
- Return type
decorator
-
tp.cli.options.doping_type_option(f)[source]¶ Option for doping type.
- –typestr, optional
doping type. Default: n.
- Returns
doping type option decorator.
- Return type
decorator
-
tp.cli.options.dos_function(dosargs=['-c', '--colour'])[source]¶ Function for creating DoS options.
- Parameters
dosargs (array-like, optional) – names for the colour argument. Default: [‘-c’, ‘–colour’].
- Returns
DoS options decorator.
- Return type
decorator
-
tp.cli.options.fill_options(f)[source]¶ Group of options for fillable line plots
- –fill, -f/–nofillbool, optional
fill under line. Default: –fill.
- –fillalphastr, optional
fill opacity (0-1). Only works for #RRGGBB colours. Default: 0.2.
- –line/–nolinebool, optional
show line. Default: –line.
- Returns
fill options decorator.
- Return type
decorator
-
tp.cli.options.inputs_function(name='filenames', nargs=- 1)[source]¶ Function for creating input arguments.
- Parameters
name (str, optional) – filename argument. Default: ‘filenames’.
nargs (int, optional) – number of input files allowed. Default: -1.
- Returns
input argument decorator.
- Return type
decorator
-
tp.cli.options.interpolate_options(f)[source]¶ Options for interpolation.
- –interpolate, -iint, optional
number of points to interpolate. Default: 200.
- –kindstr, optional
interpolation kind. Default: linear.
- Returns
interpolation options decorator.
- Return type
decorator
-
tp.cli.options.kpoints_options(f)[source]¶ Group of options for handling KPOINTS files.
- –kpoints, -k, –ibzkbt, -istr, optional
KPOINTS/IBZKPT file. Overrides –mesh.
- –mesh, -m3x int, optional
k-point mesh. Overridden by –kpoints.
- –poscar, -pstr, optional
POSCAR. Required for –mesh.
- Returns
kpoints options decorator.
- Return type
decorator
-
tp.cli.options.legend_function(toggle=True, label=True)[source]¶ Function for creating legend options.
- Parameters
toggle (bool, optional) – include option to remove legend. Default: True.
label (bool, optional) – include option to set labels manually. Default: True.
- Returns
legend options decorator.
- Return type
decorator
-
tp.cli.options.line_options(f)[source]¶ Group of options for line plots
- –linestylestr, optional
linestyle(s). Default: solid.
- –markerstr, optional
marker(s). Default: None.
- Returns
line options decorator.
- Return type
decorator
-
tp.cli.options.plot_io_function(name)[source]¶ Function for creating plot I/O options.
- Parameters
name (str) – output filename.
- Returns
plot I/O options decorator.
- Return type
decorator