diff --git a/README.rst b/README.rst index 71ec902..b57ffcf 100644 --- a/README.rst +++ b/README.rst @@ -1,22 +1,23 @@ anisotropy ========== -.. figure:: docs/source/static/simple.png - :scale: 50% - :align: center - :alt: - - -.. figure:: static/simple.png - :scale: 50% - :align: center - :alt: - anisotropy is a ``Python`` package that is the result of science-research work on the anisotropy of permeability in the periodic porous media. A project uses own wrappers around external applications for constructing a shapes and meshes (``Salome``) and computing a flow (``OpenFOAM``). + +.. figure:: docs/source/static/simple.png + :align: center + :alt: + + +.. figure:: static/simple.png + :align: center + :alt: + +.. contents:: Table of contents + Dependencies ------------ @@ -33,7 +34,7 @@ Installation .. toctree:: :maxdepth: 2 - INSTALL + Installation guide Getting Started --------------- @@ -74,7 +75,7 @@ Example: .. attention:: * You can't compute a flow without mesh (if you didn't it before succesfully). - * ``type``, ``direction`` and ``theta`` is control parameters. If you aren't specifying it than default range of values will be used from ``anisotropy.toml``. + * ``type``, ``direction`` and ``theta`` are control parameters. If you aren't specifying it than default range of values will be used from ``anisotropy.toml``. Post-processing ~~~~~~~~~~~~~~~ diff --git a/docs/source/README.rst b/docs/source/README.rst index 71ec902..b57ffcf 100644 --- a/docs/source/README.rst +++ b/docs/source/README.rst @@ -1,22 +1,23 @@ anisotropy ========== -.. figure:: docs/source/static/simple.png - :scale: 50% - :align: center - :alt: - - -.. figure:: static/simple.png - :scale: 50% - :align: center - :alt: - anisotropy is a ``Python`` package that is the result of science-research work on the anisotropy of permeability in the periodic porous media. A project uses own wrappers around external applications for constructing a shapes and meshes (``Salome``) and computing a flow (``OpenFOAM``). + +.. figure:: docs/source/static/simple.png + :align: center + :alt: + + +.. figure:: static/simple.png + :align: center + :alt: + +.. contents:: Table of contents + Dependencies ------------ @@ -33,7 +34,7 @@ Installation .. toctree:: :maxdepth: 2 - INSTALL + Installation guide Getting Started --------------- @@ -74,7 +75,7 @@ Example: .. attention:: * You can't compute a flow without mesh (if you didn't it before succesfully). - * ``type``, ``direction`` and ``theta`` is control parameters. If you aren't specifying it than default range of values will be used from ``anisotropy.toml``. + * ``type``, ``direction`` and ``theta`` are control parameters. If you aren't specifying it than default range of values will be used from ``anisotropy.toml``. Post-processing ~~~~~~~~~~~~~~~ diff --git a/docs/source/static/simple.png b/docs/source/static/simple.png index d07ed98..bf4a02b 100644 Binary files a/docs/source/static/simple.png and b/docs/source/static/simple.png differ