Commit f63e544a authored by Lukas Riedel's avatar Lukas Riedel

Revert "Revert "Use sphinx-argparse to directly document CLI from Python code""

This reverts commit 69eb43f5
parent b2185fcc
......@@ -54,6 +54,7 @@ extensions = [
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx_cmake_dune',
'sphinxarg.ext',
'breathe'
]
......
......@@ -2,28 +2,10 @@
DORiE 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. It takes three main arguments:
DORiE consists of two main executables and multiple utility scripts.
This wrapper script supplies input files, and manages the execution of these
routines.
.. object:: dorie.py
The script is technically a Python script but can be executed with a simple `./dorie` command.
.. option:: dorie create
This command creates input files for executing DORiE. They are set up with the default values supplied by the :doc:`Parameter Scraper <dorie.parscraper>` and have to be adapted for the first program run.
.. option:: pfg <config>
Execute the DORiE Parameter Field Generator. Given a config file (default: `parfield.ini`), this command will create a parameter field file in the H5 format representing the soil architecture for the simulation.
.. option:: run <config>
Execute the DORiE PDE solver. Depending on the options given in the config file (default: `config.ini`), the command will execute the main solver routine.
.. option:: plot <vtk>
Call the Python plotting script on a single `.vtk` file. Prints the values of the specified (or all) variables into `.png`files.
.. option:: -h
Print help messages. This option can be combined with all other options for details on how to formulate the command and its arguments
.. argparse::
:ref: dorie.cli.parser.create_cl_parser
:prog: dorie
\ No newline at end of file
Sphinx
sphinx_rtd_theme
sphinx-argparse
breathe
recommonmark
\ No newline at end of file
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