Skip to content

Sparkling

load_bcs()

Load the Sparkling Lake meteorology CSV file.

Returns:

Type Description
Dataframe

Pandas dataframe of the Sparkling Lake meteorology CSV file.

load_nml()

Load the Sparkling Lake NML file.

Returns:

Type Description
dict

Dictionary of the Sparkling Lake NML file.

run_sim(inputs_dir='sparkling', glm_path=None)

Run the Sparkling Lake simulation.

Sparkling Lake is an oligotrophic, northern temperate lake (89.7 ºN, 46.3 ºW) in Winconsin, USA. The lake has a surface area of 0.638 km2, and is about 20 m deep. The model is set-up to simulate the hydrological domain of Sparkling Lake for 2 years, from 1980-04-15 to 1982-04-15 (&time), with water balance and heat fluxes hypothetically calculated based on the lake configuration and input data. In this model, water quality functionality (AED2) (&wq_setup) is disabled. For more information see: https://github.com/AquaticEcoDynamics/glm-aed/tree/main/glm-examples/Sparkling.

Parameters:

Name Type Description Default
inputs_dir str

Directory path where the model inputs will be saved. Default is "sparkling".

'sparkling'
glm_path Union[str, None]

Optional. Path to an external GLM binary. Default is None.

None

Examples:

>>> from glmpy.example_sims import sparkling
>>> sparkling.run_sim()