Update Tutorial authored by Bouvry Arnaud's avatar Bouvry Arnaud
...@@ -7,7 +7,8 @@ This tutorial provides a guide to simulate an agrivoltaic system with PASE. ...@@ -7,7 +7,8 @@ This tutorial provides a guide to simulate an agrivoltaic system with PASE.
# Modules # Modules
The PASE software is coded in object-oriented Python. The engine running the computations is made of modules, located in the MODULES/ directory. The PASE software is coded in object-oriented Python.
The engine running the computations is made of modules, located in the MODULES/ directory.
Those modules are imported at the start of the simulation script. Those modules are imported at the start of the simulation script.
...@@ -17,7 +18,8 @@ As a user, you can easily run PASE using the `example.py` script "as is" and onl ...@@ -17,7 +18,8 @@ As a user, you can easily run PASE using the `example.py` script "as is" and onl
These parameters are set in YAML configuration files contained in the INPUTS/ directory's subdirectories. These parameters are set in YAML configuration files contained in the INPUTS/ directory's subdirectories.
Each parameter in these files includes detailed information such as: Each parameter in these files includes detailed information such as:
* Value Type: Specifies the type of input required (e.g., integer, string, etc.). * Value: The value of the parameter
* Type: Specifies the type of input required (e.g., integer, string, etc.).
* Limits: Provides acceptable ranges for the parameter values. * Limits: Provides acceptable ranges for the parameter values.
* Unit: Indicates the unit of measurement. * Unit: Indicates the unit of measurement.
* Definition: Brief explanation of the parameter to clarify its purpose. * Definition: Brief explanation of the parameter to clarify its purpose.
...@@ -35,10 +37,11 @@ The parameters are located in several subdirectories according to their purpose: ...@@ -35,10 +37,11 @@ The parameters are located in several subdirectories according to their purpose:
# Running a simulation # Running a simulation
Once the parameters are set, the simulation can start. The program is split in several blocks : Once the parameters are set, the simulation can start.
The program is split in several blocks :
- Load inputs: load contents of the input parameter files - Load inputs: load contents of the input parameter files
- Pre-processing: instantiate the simulation configuration, compute light interception by elements of the scene - Pre-processing: instantiate the simulation configuration, compute light interception by elements of the scene
- Processing: compute PV and crop production - Processing: compute PV and crop production
Note: when running the simulation, depending on your development environment, you may have to close the opened figures to proceed through the script. Note: when running the simulation, depending on your development environment, you may have to close the opened figures that pop up during the simulation to proceed through the script.