{% extends "dashboard/base.html" %} {% load static %} {% block title %}Help{% endblock %} {% block content %}
R2H2 is a desktop simulation tool for renewable-to-hydrogen systems. This page covers the key workflows and tips to get the most from the app.
A controller is a Python file with a single control(units, battery, t_out, settings) function. It replaces the built-in dispatch logic and lets you implement custom on/off scheduling or proportional sharing strategies.
On the simulation detail page, open the Controller panel → click New → choose a base file and enter a name (lowercase letters and underscores only, no .py extension). Edit the code directly in the browser. Click Save before running.
Full reference: Dynamic Controller User Guide
If a custom controller takes longer than 30 s for a single hourly call, it is automatically cancelled and the built-in dynamicControl is used as a fallback. A warning is raised in the run log.
Custom controllers must be causal: for output sample k, only input data from indices 0..k and prior internal state may be used. Do not use future samples beyond the current time step when making a decision.
On the Models & Simulations list, use the duplicate icon to copy a simulation and all its component links. Useful for parameter sweeps without touching the original.
Set a Datum date on the simulation to align result charts to a real calendar timeline. The datum date is also used as the origin for 1 Hz data collection date ranges.
Use the Duration (days) field to run only the first N days of a wind file — useful for quick parameter checks before committing to a full multi-year run.
Enable Collect 1 Hz data on the simulation detail page to record per-second time-series over a chosen date window. The data is stored in the output HDF5 under /time_series_1hz and can be plotted directly in the results view. Limit the window to roughly 3 months or less to keep file sizes manageable.
Link more than one wind HDF5 file to a simulation on the Wind Data panel. Files are concatenated in sequence order (drag rows to reorder), allowing multi-year or multi-site wind inputs without modifying the source files.
On the simulation detail page each component group has an Add button to link an existing unlinked instance, and a Not linked button on each row to remove it. Components are shared across simulations — unlinking does not delete the component.
| Version | {{ version }} |
| Licence | GNU GPL v3 |
| Authors | Adam Stock, Francesco Superchi, Peter McCallum |
| Institution | Heriot-Watt University |
| Latest Release | pypi.org/project/r2h2/ |
| Source | github.com/RenewableTools/R2H2_app |
| Django | {{ django_version }} |
| Python | {{ python_version }} |
Pull the latest source code from GitHub. You will need to restart the app after updating.