gearshift package

Subpackages

• gearshift.cli package
  • Module contents
    • gearshift
      • demo
      • run
• gearshift.core package
  • Subpackages
    • gearshift.core.load package
      • Submodules
      • gearshift.core.load.excel module
      • Module contents
    • gearshift.core.model package
      • Subpackages
      • Module contents
    • gearshift.core.write package
      • Submodules
      • gearshift.core.write.excel module
      • Module contents
  • Module contents

Module contents

Defines the file processing chain model dsp.

Sub-Modules:

core	Functions and dsp model to processes a JR-Shift input file.
cli	Define gearshift command line interface.

init_conf(inputs)

Initialize GEARSHIFT model configurations.

Parameters:

inputs (dict | schedula.Token) – Initialization inputs.

Returns:

Initialization inputs.

Return type:

dict | schedula.Token

register_core()

Register core model.

Returns:

GEARSHIFT core model.

Return type:

schedula.Dispatcher

default_timestamp(start_time)

Returns the default timestamp.

Parameters:

start_time (datetime.datetime) – Run start time.

Returns:

Run timestamp.

Return type:

str

run_core(core_model, input_files, output_folder, cmd_flags, timestamp, output_format, **kwargs)

Run core model.

Parameters:

• core_model (schedula.Dispatcher) – GEARSHIFT core model.

• cmd_flags (dict) – Command line options.

• timestamp (str) – Run timestamp.

• input_files (iterable) – List of input files and/or folders.

Returns:

Core model solutions.

Return type:

dict[str, schedula.Solution]

save_demo_files(output_folder, demo_flag)

Save GEARSHIFT demo files.

Parameters:

output_folder (str) – Output folder.

default_start_time()

Returns the default run start time.

Returns:

Run start time.

Return type:

datetime.datetime

log_done(start_time)

Logs the overall execution time.

Parameters:

start_time (datetime.datetime) – Run start time.

Returns:

Execution time [s].

Return type:

datetime.datetime