A new command-line interface (CLI) will be implemented so that the end user can call CLOVER from the command line with a series of parameters to specify how the run should be carried out.
Location-generation interface
A --from-existing <template_location_name> flag which takes in a string giving the name of an existing location to use as a template. In this instance, values for entries in the template files will be taken from the existing location.
A --new-location-name <location_name> flag which takes in a string giving the name to use when generating the new location.
A --check or --update-location-name <location_name flag which takes in a string giving the name of a location to update. Any missing files in this location, which have either been deleted by the user since the location was generated or which are now required due to an update to CLOVER, will be created within this location folder.
Profile-generation interface
A --location <location_name> flag which takes in a string giving the name of the location for which the various profiles should be generated.
A --regenerate flag which,
If specified, causes CLOVER to regenerate the various profiles,
Otherwise, if not specified,
CLOVER will generate the profiles if they don’t exist,
And will inform the user if the profiles already exist and will not regenerate them.
Simulation interface
Command-line arguments
A --location <location_name> flag which takes in a string giving the name of the location to use for the run of CLOVER.
A --regenerate optional boolean flag. See #34 for more information;
A --load-profile-name <load_profile_filename> optional flag which takes in a string giving the name of the load profile to use for the run of CLOVER. If the flag is not used, the default load profile name is used. The name of the load profile used is displayed on the screen. If the load profiles directory doesn’t contain either the default or the named load profile, then CLOVER errors.
An --output <output_file_directory>/<output_file_name> flag which takes in a string to specify the name of the output file to which the output of the CLOVER simulation should be saved.
A --pv-system-size <pv_system_size> flag which takes in a float to give the size of the PV system in kWp;
A --scenario <scenario_file> flag which takes in a string to specify the path to the scenario file;
A --storage-size <storage_size> flag which takes in a float to give the size of the storage system in kWh.
In-file parameters
An --end-year <end_year> parameter which takes in an integer to specify the year to end the simulation.
A --start-year <start_year> flag which takes in an integer to specify the year to start the simulation.
Insights/Analysis Interface
An --input <input_file_name> flag which takes in a string to specify the path to the output file, generated by the simulation run, which should be used in the analysis to generate the various output text and graphical files. It will be made explicit to the user that they can do a lot more than what is contained in the standard package and that they can expand on it.
NOTE: Provide template analysis instructions.
NOTE:graphing module, in charge of pictures and graph construction, __init_sublcass__ hooks.
Optimisation Interface
Individual optimisations
Command-line interface
A --location <location_name> flag which takes in a string giving the name of the location to use for the run of CLOVER;
An --output <output_file_name> flag which takes in a string to specify the name of the output file to which the output of the CLOVER simulation should be saved;
A --regenerate optional boolean flag. See #34 for more information;
A --scenario <scenario_file> flag which takes in a string to specify the path to the scenario file.
In-file parameters:
A --number-of-iterations <num_iterations> flag which takes an integer giving the number of these time periods which should constitute the scenario;
A --iteration-length <iteration_length> flag which takes an integer giving the length of the iteration (step-by-step) time period in years.
E.G., using --iteration-length 5 --number-of-iterations 3 would result in an iteration length of 5 years and a scenario length of 15 years.
Multiple optimisations
Parameters are, for the most part, the same as the individual-optimisation parameter set, with the addition of
Command-line arguments
A --multiple-optimisations-file <optimisation_file> flag which takes in a string to specify the name of a file containing information about the various optimisations that are to be carried out.
A new command-line interface (CLI) will be implemented so that the end user can call CLOVER from the command line with a series of parameters to specify how the run should be carried out.
Location-generation interface
--from-existing <template_location_name>flag which takes in a string giving the name of an existing location to use as a template. In this instance, values for entries in the template files will be taken from the existing location.--new-location-name <location_name>flag which takes in a string giving the name to use when generating the new location.--checkor--update-location-name <location_nameflag which takes in a string giving the name of a location to update. Any missing files in this location, which have either been deleted by the user since the location was generated or which are now required due to an update to CLOVER, will be created within this location folder.Profile-generation interface
--location <location_name>flag which takes in a string giving the name of the location for which the various profiles should be generated.--regenerateflag which,Simulation interface
Command-line arguments
--location <location_name>flag which takes in a string giving the name of the location to use for the run of CLOVER.--regenerateoptional boolean flag. See #34 for more information;--load-profile-name <load_profile_filename>optional flag which takes in a string giving the name of the load profile to use for the run of CLOVER. If the flag is not used, the default load profile name is used. The name of the load profile used is displayed on the screen. If the load profiles directory doesn’t contain either the default or the named load profile, then CLOVER errors.--output <output_file_directory>/<output_file_name>flag which takes in a string to specify the name of the output file to which the output of the CLOVER simulation should be saved.--pv-system-size <pv_system_size>flag which takes in a float to give the size of the PV system in kWp;--scenario <scenario_file>flag which takes in a string to specify the path to the scenario file;--storage-size <storage_size>flag which takes in a float to give the size of the storage system in kWh.In-file parameters
--end-year <end_year>parameter which takes in an integer to specify the year to end the simulation.--start-year <start_year>flag which takes in an integer to specify the year to start the simulation.Insights/Analysis Interface
--input <input_file_name>flag which takes in a string to specify the path to the output file, generated by the simulation run, which should be used in the analysis to generate the various output text and graphical files. It will be made explicit to the user that they can do a lot more than what is contained in the standard package and that they can expand on it. NOTE: Provide template analysis instructions. NOTE:graphingmodule, in charge of pictures and graph construction,__init_sublcass__hooks.Optimisation Interface
Individual optimisations
Command-line interface
--location <location_name>flag which takes in a string giving the name of the location to use for the run of CLOVER;--output <output_file_name>flag which takes in a string to specify the name of the output file to which the output of the CLOVER simulation should be saved;--regenerateoptional boolean flag. See #34 for more information;--scenario <scenario_file>flag which takes in a string to specify the path to the scenario file.In-file parameters:
A
--number-of-iterations <num_iterations>flag which takes an integer giving the number of these time periods which should constitute the scenario; A--iteration-length <iteration_length>flag which takes an integer giving the length of the iteration (step-by-step) time period in years. E.G., using--iteration-length 5 --number-of-iterations 3would result in an iteration length of 5 years and a scenario length of 15 years.Multiple optimisations
Parameters are, for the most part, the same as the individual-optimisation parameter set, with the addition of
Command-line arguments
--multiple-optimisations-file <optimisation_file>flag which takes in a string to specify the name of a file containing information about the various optimisations that are to be carried out.