Skip to content

new

exampleinput

exampleinput(directory='.', outer=None)

exampleinput.

PARAMETER DESCRIPTION
directory

Directory to create the example input file in

TYPE: Optional[str] DEFAULT: '.'

outer

DEFAULT: None

RETURNS DESCRIPTION
Optional[Path]

None if the given directory does not exist. Path to the created example input file if successful.

module

module(module_name, module_type, outer=None)

module.

PARAMETER DESCRIPTION
module_name

Module name

TYPE: str

module_type

Module type

TYPE: str

RETURNS DESCRIPTION
Optional[Path]

None if not successful. Directory of the created module if successful.