Skip to content

Commit 351c088

Browse files
committed
add docstring for model class
1 parent 86b5f49 commit 351c088

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

PyStemmusScope/stemmus_scope.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,22 @@
1414

1515

1616
class StemmusScope():
17+
"""PyStemmusScope wrapper around Stemmus_Scope model.
18+
see https://gmd.copernicus.org/articles/14/1379/2021/
19+
20+
It sets the model with a configuration file and executable file.
21+
It also prepares forcing and soil data for model run.
22+
23+
Args:
24+
config_file(str): path to Stemmus_Scope configuration file. An example
25+
config_file can be found in tests/test_data in `STEMMUS_SCOPE_Processing
26+
repository <https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing>`_
27+
exe_file(str): path to Stemmus_Scope executable file.
28+
29+
Example:
30+
See notebooks/run_model_in_notebook.ipynb in `STEMMUS_SCOPE_Processing
31+
repository <https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing>`_
32+
"""
1733

1834
def __init__(self, config_file: str, exe_file: str):
1935
# make sure paths are abolute and path objects

0 commit comments

Comments
 (0)