Commit 40cd0baa authored by Jesse VanderWees's avatar Jesse VanderWees 🐘

added how to run RTC-Tools

parent bc8d2dc1
......@@ -17,7 +17,7 @@ does not want to end up with too much water at the end of the six days. They
have chosen to use RTC-Tools to calculate how much water to release and when
to release it.
The folder ``<installation directory>\RTCTools2\examples\basic``
The folder ``rtc-tools\examples\basic``
contains a complete RTC-Tools optimization problem. An RTC-Tools
directory has the following structure:
......@@ -189,10 +189,10 @@ All together, the whole example script is as follows:
Running RTC-Tools
-----------------
To run this basic example in RTC-Tools, navigate to the ``<installation
directory>\RTCTools2\examples\basic\src`` directory in the RTC-Tools shell and
run the example using ``python example.py``. For more details about using
RTC-Tools, see :ref:`running-rtc-tools`.
To run this basic example in RTC-Tools, navigate to the basic example ``src``
directory in the RTC-Tools shell and run the example using ``python
example.py``. For more details about using RTC-Tools, see
:ref:`running-rtc-tools`.
Extracting Results
------------------
......
......@@ -9,7 +9,7 @@ Using an Ensemble Forecast
:doc:`basic`.
Then biggest change to RTC-Tools when using an ensemble is the structure of the
directory. The folder ``<installation directory>\RTCTools2\examples\ensemble``
directory. The folder ``rtc-tools\examples\ensemble``
contains a complete RTC-Tools ensemble optimization problem. An RTC-Tools
ensemble directory has the following structure:
......
......@@ -28,10 +28,9 @@ only when necessary.
The model can be viewed and editied using the OpenModelica Connection Editor
program. First load the Deltares library into OpenModelica Connection Editor,
and then load the example model, located at ``<installation
directory>\RTCTools2\examples\mixed_integer\model\Example.mo``. The
model ``Example.mo`` represents a simple water system with the following
elements:
and then load the example model, located at
``rtc-tools\examples\mixed_integer\model\Example.mo``. The model ``Example.mo``
represents a simple water system with the following elements:
* a canal segment, modelled as storage element
``Deltares.ChannelFlow.Hydraulic.Storage.Linear``,
......
Getting Started
+++++++++++++++
Installation
============
......@@ -126,3 +129,32 @@ Deltares Modelica library remains for the user to set::
C:\path\to\JModelica\Python.bat example.py
.. _Deltares Download Portal: https://download.deltares.nl/en/download/rtc-tools/
.. _running-rtc-tools:
Running RTC-Tools
=================
RTC-Tools is run from a command line shell. If you installed using the Windows
executable, the RTC-Tools Shell can be started by clicking::
Start -> Programs -> RTC-Tools -> Shell
Once you have started the shell, navigate to the ``src`` directory of the case
you wish to optimize, e.g.::
cd \path\to\rtc-tools\examples\basic\src
Then, to run the case with RTC-Tools, run the ``src`` python script, e.g.::
python example.py
You will see the progress of RTC-Tools in your shell. All your standard shell
commands can be used in the RTC-Tools shell. For example, you can use::
python example.py > log.txt
to pipe RTC-Tools output to a log file.
......@@ -12,11 +12,18 @@
RTC-Tools documentation
=======================
This is the documentation for RTC-Tools 2.0, the `Deltares <https://www.deltares.nl/>`_ toolbox for control and optimization of environmental systems.
This is the documentation for RTC-Tools 2.0, the `Deltares
<https://www.deltares.nl/>`_ toolbox for control and optimization of
environmental systems.
Visit the `RTC-Tools website <https://www.deltares.nl/en/software/rtc-tools/>`_ for a general product description and information on available services.
Visit the `RTC-Tools website <https://www.deltares.nl/en/software/rtc-tools/>`_
for a general product description and information on available services.
This first chapter covers installation of the software. The subsequent two chapters describe the RTC-Tools Python API. The fourth and final chapter discusses several illustrative examples, including the use of goal programming for multi-objective optimization, as well as the use of forecast ensembles.
This first chapter covers getting the software running on your computer. The
subsequent two chapters describe the RTC-Tools Python API. The fourth and final
chapter discusses several illustrative examples, including the use of goal
programming for multi-objective optimization, as well as the use of forecast
ensembles.
Contents
......@@ -25,7 +32,7 @@ Contents
.. toctree::
:maxdepth: 2
installation
getting-started
optimization
simulation
examples
......
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