Create simulation parameters

AUTHORS: Julien Ruffault (julien.ruff@gmail.com), Nicolas Martin-StPaul (nicolas.martin@inrae.fr)

---

source

create_simulation_parameters

 create_simulation_parameters (main_dir:str, start_year_simulation:int,
                               end_year_simulation:int, output_path:str,
                               output_type:str=None,
                               resolution_output:str='subdaily',
                               overwrite:bool=False)

Create a dictionary with the simulation parameters to run SureauEcos. Can be used as an input in

	Type	Default	Details
main_dir	str		Unknown parameter definition
start_year_simulation	int		Integer indicating the starting year for the simulation
end_year_simulation	int		Integer indicating the ending year for the simulation (must match the dates of the input climate data file)
output_path	str		Path of output result file.
output_type	str	None	The output variables of the model that should be written in the output model file.
resolution_output	str	subdaily	the resolution chosen to write variables in files, subdaily, daily or yearly.
overwrite	bool	False	Indicates whether the output result file can be overwritten if it already exists
Returns	typing.Dict

Example: Create simulation parameters dictionary

create_simulation_parameters(
    main_dir="./sample_data",
    start_year_simulation=1991,
    end_year_simulation=1991,
    output_type="simple_daily",
    output_path="./sample_data",
    overwrite=True,
    resolution_output="subdaily",
)

defaultdict(list,
            {'main_dir': './sample_data',
             'resolution_output': 'subdaily',
             'output_type': 'simple_daily',
             'output_path': './sample_data/sureau_output',
             'start_year_simulation': 1991,
             'end_year_simulation': 1991})