To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit 811cbcb1 authored by Xuqian Yan's avatar Xuqian Yan
Browse files

Updated contents for stand-along postprocess

parent 8406ebab
......@@ -15,8 +15,12 @@ After a simulation finishes, selected results are **postprocessed** and uploaded
- **Purpose**: Automatically process the results when finishing a simulation, so that the reseacher could promtly see the results of this simulation from the webviewer.
- **How it work**: After the simulation finishes, `run_Nexuse.m` calls the MATLAB script `Shared/resultPostProcess/postProcess.m`. This scripts calls other MATLAB/Python scripts to postprocess the results.
2. **Stand-alone**
- **Purpose**: Batch-process multiple simulations, fine-tune/modify/test the post-process scripts. This stand-alone process provides the final data to the webviewer.
- **How it works**: Run the `postProcess` bash script locally. This bash script loops over multiple simulations and takes configurations (e.g., which simulations to loop through and scenario names for each simulation) from the `Shared/resultPostProcess/postProcess.conf` file.
- **Purpose**: Batch-process multiple simulations, fine-tune/modify/test/debug the post-process scripts.
- **How it works**: Run the MATLAB script `postProcess_batch.m` locally. This script loops through multiple simulations and runs only the required post-process scripts (e.g., we don't have to run the complete post-process for quick debugging). Which simulations to loop through and which post-processes to run can be configured at the "To be edited" section in the script. Details can be found in the comments in the script.
```eval_rst
.. note::
To properly run the :code:`postProcess_batch.m` script, you need to set up the paths for the required software (e.g., Python, GAMS). To do this, follow the instructions in :code:`Run_Nexuse/user_example_conf.m` and the `online documentation <https://nexus-e.readthedocs.io/en/latest/setup.html#prepare-software-license>`_.
```
#### Output database
......@@ -43,4 +47,4 @@ After the postprocessed data has been uploaded to the output database, the data
#### Embed the webviewer into the homepage
The webviewer itself is plainly a Python Dash application without much Nexus-e branding. To change this, it is embedded into the homepage with [iframe](https://www.w3schools.com/html/html_iframe.asp) - a html element to display a nested webpage within another webpage. By doing so, we can easily have the same header, footer and menubar for the visualization tool as in other Nexus-e webpages.
The embedding can only be done by the administrators of the homepage. If you are an administrator, you could [login](https://nexus-e.org/login/) to the homepage and check the backend of [this page](https://nexus-e.org/results-flexibility-providers/) to learn how it is done.
\ No newline at end of file
The embedding can only be done by the administrators of the homepage. If you are an administrator, you could [login](https://nexus-e.org/login/) to the homepage and check the backend of [this page](https://nexus-e.org/results-flexibility-providers/) to learn how it is done.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment