Commit 670ecb2a authored by Lukas Riedel's avatar Lukas Riedel

Rename 'Quickstart' doc section to 'Manual', adapt file names.

Also remove unnecessary mentions of 'DORiE' in document titles.
parent 0da8e326
......@@ -40,11 +40,11 @@ dune_cmake_sphinx_doc(SPHINX_CONF ${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in
python-dorie-parscraper.rst
python-dorie-testtools.rst
python-dorie-utilities.rst
quickstart-bcfile.rst
quickstart-cookbook.rst
quickstart-installation.rst
quickstart-parameters.rst
quickstart-parameter-file.rst
man-bcfile.rst
man-cookbook.rst
man-installation.rst
man-config-file.rst
man-parameter-file.rst
MODULE_ONLY)
if(TARGET sphinx_html)
......
......@@ -20,11 +20,11 @@ A ready-to-use application is available from `Docker Hub <https://hub.docker.com
DORiE is licensed under the `MIT License <https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/blob/master/LICENSE.md>`_.
Never used DORiE before? Get to learn its features by working through :ref:`quickstart`.
If you have already installed DORiE, jump straight to the :doc:`quickstart-cookbook`
If you have already installed DORiE, jump straight to the :doc:`man-cookbook`
and have a look at the test cases described therein!
You might also want to have a look at both the :doc:`quickstart-parameters`
and :doc:`quickstart-bcfile`, explaining all input parameters and boundary condition
You might also want to have a look at both the :doc:`man-config-file`
and :doc:`man-bcfile`, explaining all input parameters and boundary condition
files, respectively.
A complete documentation of the :ref:`DORiE source code <c-reference>`, the
......@@ -39,17 +39,17 @@ Contents
.. _quickstart:
Quick Start
-----------
Manual
------
.. toctree::
:maxdepth: 1
quickstart-installation
quickstart-cookbook
quickstart-parameters
quickstart-bcfile
man-installation
python-dorie-wrapper
man-config-file
man-bcfile
man-cookbook
public-api
.. _c-reference:
......
......@@ -102,7 +102,7 @@ These lines follow a simple grammar:
The boundary conditions defined here are parsed in the same order as the boundary segments have been specified. In 3D, the rectangular boundary segments are parsed in a tabular fashion, where columns run faster than rows. Columns are defined along the first direction specified in the `Boundary Segmentation`_, and rows are defined along the second direction.
.. figure:: figures/quickstart-bcfile-segm1.png
.. figure:: figures/man-bcfile-segm1.png
:width: 40 %
:align: left
......
DORiE Configuration File Guide
******************************
Configuration File Guide
************************
.. contents::
:depth: 2
......
......@@ -11,14 +11,14 @@ This part of the documentation is intended for first-time DORiE users. It explai
Prerequisites
-------------
Before you start, make sure that :doc:`DORiE is installed correctly <quickstart-installation>`. To analyze DORiE's results to their full extend, install Paraview_. DORiE will create rectangular grids according to user specifications on the fly, using the DUNE GridFactory. For building simplex grids in two or three dimensions, you can use Gmsh_. Its :file:`.msh` files can be read directly into DORiE to run simulations on.
Before you start, make sure that :doc:`DORiE is installed correctly <man-installation>`. To analyze DORiE's results to their full extend, install Paraview_. DORiE will create rectangular grids according to user specifications on the fly, using the DUNE GridFactory. For building simplex grids in two or three dimensions, you can use Gmsh_. Its :file:`.msh` files can be read directly into DORiE to run simulations on.
DORiE Input Files
-----------------
DORiE needs multiple input files to work:
* **Parameter File:** (:file:`.ini`) Supplying static information on the simulation. Have a look at the :doc:`quickstart-parameters` for more information on the file syntax, or default and possible values.
* **Boundary Condition Datafile:** (:file:`.bcdat`) Specifying the boundary conditions dependent on time and space.Name (and path) of the desired file have to be stated in the Parameter File at key ``boundary.file``. The :doc:`quickstart-bcfile` supplies information on how write and use the BC Datafile.
* **Parameter File:** (:file:`.ini`) Supplying static information on the simulation. Have a look at the :doc:`man-config-file` for more information on the file syntax, or default and possible values.
* **Boundary Condition Datafile:** (:file:`.bcdat`) Specifying the boundary conditions dependent on time and space.Name (and path) of the desired file have to be stated in the Parameter File at key ``boundary.file``. The :doc:`man-bcfile` supplies information on how write and use the BC Datafile.
* *Optional* **Mesh File:** (:file:`.msh`) Representing the grid on which the simulation will run. This file is only required if ``grid.gridType = simplex`` is chosen in the Parameter File. The Path to the file and it's name will then have to be stated at ``grid.gridFile``. Use Gmsh_ to easily create such a file.
DORiE Output Files
......
*********************
Public API Definition
*********************
**********
Public API
**********
DORiE's Public API comprises the usage of the compiled program as well as the
main code segments for using instances of DORiE in other (DUNE) modules and
......@@ -12,11 +12,11 @@ Command Line API
The compiled program and the Docker application are executed via the
:doc:`Command Line Interface <python-dorie-wrapper>`. The specifications for the
respective configuration files are given in the
:doc:`Config File Guide <quickstart-parameters>`.
:doc:`Config File Guide <man-config-file>`.
The main routine (`dorie run <config>`) also requires input files for
:doc:`boundary conditions <quickstart-bcfile>` and
:doc:`soil parameters <quickstart-parameter-file>`.
:doc:`boundary conditions <man-bcfile>` and
:doc:`soil parameters <man-parameter-file>`.
Code API
========
......@@ -24,7 +24,7 @@ Code API
DORiE supplies the `Simulation` template. This is the main class for assembling
and running the solver.
.. doxygenclass:: Dune::Dorie::Simulation
.. doxygenclass:: Dune::Dorie::RichardsSimulation
:members:
The simulation template requires compile-time type specifications wrapped in a
......
......@@ -16,7 +16,7 @@ It provides the following components:
- a :mod:`matching function <dorie.parscraper.match_parameters>` that complements the information from the XML file with the location where each parameter is actually used in the code,
- :mod:`Writers <dorie.parscraper.writers>` for various output formats (e.g. to dynamically create the .ini files used in runs of the main program, or to create :doc:`a user cheat sheet <quickstart-parameters>` with further explanations),
- :mod:`Writers <dorie.parscraper.writers>` for various output formats (e.g. to dynamically create the .ini files used in runs of the main program, or to create :doc:`a user cheat sheet <man-config-file>` with further explanations),
- a :mod:`wrapper script <dorie.parscraper.wrapper>` controlling the scraping process.
......
****************************
DORiE Command Line Interface
****************************
**********************
Command Line Interface
**********************
DORiE consists of two main executables and multiple utility scripts.
This wrapper script supplies input files, and manages the execution of these
routines.
.. argparse::
:ref: dorie.cli.parser.create_cl_parser
......
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