Commit 4f7c76e8 authored by Lukas Riedel's avatar Lukas Riedel

Merge branch 'fix-docs-for-1-1-release' into 'master'

Update README and installation instructions in Sphinx docs

Closes #48

See merge request !72
parents 0cd6b69c eb256b99
......@@ -10,10 +10,13 @@ DORiE is developed and maintained by the [DORiE Developers](mailto:dorieteam@iup
# Installation Instructions
DORiE is a [DUNE](https://dune-project.org/) module and requires several other DUNE modules as well as third party software packages. Installation can be handled manually on your local machine, but for inexperienced users it is recommended to use the deployment software [Docker](https://www.docker.com/) instead.
In any case, DORiE is configured, built, and installed via the [DUNE Buildsystem](https://dune-project.org/doc/installation/), using the `dunecontrol` script to handle DUNE-internal dependencies.
No installation is necessary if you download DORiE as Docker image from
[Docker Hub](https://hub.docker.com/r/dorie/dorie/). You can then proceed
directly to the the instructions on [how to execute DORiE](#run-dorie-run).
The commands listed there are appended to the usual commands for running a
Docker container. See the description on Docker Hub for further details.
## Docker Installation - Simple Setup
......@@ -25,7 +28,7 @@ Install Docker on your machine. Then, use `git clone` to download the DORiE repo
Docker will use a prepared image from Dockerhub and install DORiE into it. You can now call DORiE via the Docker deamon from any directory `dir` on your machine:
docker run -i -t -v <dir>:/sim dorie <command>
docker run -it -v <dir>:/sim dorie <command>
The `-v` option tells docker to mount the directory into the container work directory (`sim`).
......@@ -38,6 +41,10 @@ Installing all packages manually can be quite an effort, but useful for develope
Whenever possible, dependencies should be installed using a package manager, like [APT](https://wiki.ubuntuusers.de/APT/) on Ubuntu or [Homebrew](http://brew.sh/) on Mac. Manual installation on a Windows environment is strongly discouraged!
DORiE is configured, built, and installed via the
[DUNE Buildsystem](https://dune-project.org/doc/installation/), using the
`dunecontrol` script to handle DUNE-internal dependencies.
### Dependencies
Depending on your system configuration, there will be more packages necessary to
install DORiE on your machine. See the step-by-step manual for further details.
......@@ -158,7 +165,7 @@ The following software packages are cross-platform, so you should be able to fin
## Documentation
The documentation of the current `master` branch can be found [online](http://dorie-docs.gitballoon.com) (password: `richards`).
The documentation of the current `master` branch can be found [online](http://dorie-doc.bitballoon.com/).
The documentation can be built after DORiE has been properly configured (i.e., by calling `dunecontrol`). Note that you might have to re-configure DORiE once after installing it, because some dependencies are installed at configure time (e.g. by `dunecontrol --only=dorie configure`). To build the documentation, just run
......
......@@ -64,7 +64,7 @@ adding an empty line, make text **bold** or ``monospaced``.
<parameter name="subsamplingLevel">
<definition> Plot VTK files with virtually refined grids. VTK only
supports bilinear triangulations and displays higher-order solutions
inappropriately. Use level 0 for order 1, and level N+1 for order N.
inappropriately. Use level 0 for order 1, and level N for order N.
For level &gt; 0, the printed grid does not resemble the actual grid.
This parameter defaults to 0 if not given in the config file. Notice
that subsampling significantly increases the output file size!
......
......@@ -39,7 +39,7 @@ clone the DORiE repository by executing
.. code-block:: shell
git clone ssh://git@zwackelmann.iup.uni-heidelberg.de:10022/dorie/dorie.git
git clone ssh://git@ts-gitlab.iup.uni-heidelberg.de:10022/dorie/dorie.git
in the terminal. By default, the remote host will be called ``origin``, and the
``master`` branch will be checked out. If you wish to checkout another branch, do so by calling
......@@ -56,7 +56,11 @@ from a terminal inside the repository folder. Refer to the `Atlassian Git Tutori
Installation
************
You can build DORiE locally on your machine for maximum performance. This requires you to take care of all dependencies and to handle the installation process yourself. On the other hand, you can use a virtual environment to run DORiE. We support this feature by using `Docker <https://www.docker.com/>`_. You can install DORiE into a Docker image and then execute a container from it for your computations. Depending on your operating system, this will lead to impared performance.
You can build DORiE locally on your machine for maximum performance. This requires you to take care of all dependencies and to handle the installation process yourself. On the other hand, you can use a virtual environment to run DORiE. We support this feature by using `Docker <https://www.docker.com/>`_.
You can install your local DORiE source code into a Docker image or load a
prepared image from `Docker Hub <https://hub.docker.com/r/dorie/dorie/>`_.
You can then run the application as Docker container. Depending on your
operating system, this will lead to impared performance.
Follow the Installation Instructions in the :doc:`the ReadMe <README>` for installing DORiE.
......
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