diff --git a/README.rst b/README.rst index b57ffcf..d6087b7 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ anisotropy ========== -anisotropy is a ``Python`` package that is the result of science-research work +*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``). @@ -16,10 +16,10 @@ for constructing a shapes and meshes (``Salome``) and computing a flow (``OpenFO :align: center :alt: -.. contents:: Table of contents +.. contents:: README contents Dependencies ------------- +============ .. csv-table:: :header: "Software", "Used version", "Recommended version" @@ -28,16 +28,13 @@ Dependencies "`Salome `_", "9.7.0", ">= 9.6.0" "`OpenFOAM `_", "v2012", "" -Installation ------------- -.. toctree:: - :maxdepth: 2 +.. Installation - Installation guide +.. include:: INSTALL.rst Getting Started ---------------- +=============== Initializing a new anisotropy project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -94,7 +91,7 @@ Additional help You always can use ``--help`` flag with any of ``anistropy`` command to get more information. License -------- +======= GNU GPLv3 diff --git a/anisotropy/__init__.py b/anisotropy/__init__.py index 0454390..0baa3ab 100644 --- a/anisotropy/__init__.py +++ b/anisotropy/__init__.py @@ -3,10 +3,15 @@ # License: GNU GPL version 3, see the file "LICENSE" for details. """anisotropy + +*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``). """ __license__ = "GPL3" -__version__ = "1.1.0" +__version__ = "1.2.0" __author__ = __maintainer__ = "George Kusayko" __email__ = "gkusayko@gmail.com" diff --git a/docs/source/README.rst b/docs/source/README.rst index b57ffcf..d6087b7 100644 --- a/docs/source/README.rst +++ b/docs/source/README.rst @@ -1,7 +1,7 @@ anisotropy ========== -anisotropy is a ``Python`` package that is the result of science-research work +*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``). @@ -16,10 +16,10 @@ for constructing a shapes and meshes (``Salome``) and computing a flow (``OpenFO :align: center :alt: -.. contents:: Table of contents +.. contents:: README contents Dependencies ------------- +============ .. csv-table:: :header: "Software", "Used version", "Recommended version" @@ -28,16 +28,13 @@ Dependencies "`Salome `_", "9.7.0", ">= 9.6.0" "`OpenFOAM `_", "v2012", "" -Installation ------------- -.. toctree:: - :maxdepth: 2 +.. Installation - Installation guide +.. include:: INSTALL.rst Getting Started ---------------- +=============== Initializing a new anisotropy project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -94,7 +91,7 @@ Additional help You always can use ``--help`` flag with any of ``anistropy`` command to get more information. License -------- +======= GNU GPLv3 diff --git a/docs/source/index.rst b/docs/source/index.rst index 04a352d..be7974b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,8 +8,9 @@ Welcome to anisotropy's documentation! .. toctree:: :maxdepth: 2 - :caption: Contents: + :caption: Documentation contents: + INSTALL anisotropy notes