L-Nafaryus/anisotropy
L-Nafaryus/anisotropy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Mod: preparations for release

Browse Source
This commit is contained in:
L-Nafaryus 2021-09-01 21:36:46 +05:00
parent 3e08063fca
commit c86d885ae4
No known key found for this signature in database
GPG Key ID: C76D8DCD2727DBB7
4 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.rst
View File

@ -1,7 +1,7 @@
anisotropy 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. on the anisotropy of permeability in the periodic porous media.
A project uses own wrappers around external applications A project uses own wrappers around external applications
for constructing a shapes and meshes (``Salome``) and computing a flow (``OpenFOAM``). 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 :align: center
:alt: :alt:
.. contents:: Table of contents .. contents:: README contents
Dependencies Dependencies
------------ ============
.. csv-table:: .. csv-table::
:header: "Software", "Used version", "Recommended version" :header: "Software", "Used version", "Recommended version"
@ -28,16 +28,13 @@ Dependencies
"`Salome <https://www.salome-platform.org>`_", "9.7.0", ">= 9.6.0" "`Salome <https://www.salome-platform.org>`_", "9.7.0", ">= 9.6.0"
"`OpenFOAM <https://www.openfoam.com>`_", "v2012", "" "`OpenFOAM <https://www.openfoam.com>`_", "v2012", ""
Installation
------------
.. toctree:: .. Installation
:maxdepth: 2
Installation guide <INSTALL.rst> .. include:: INSTALL.rst
Getting Started Getting Started
--------------- ===============
Initializing a new anisotropy project 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. You always can use ``--help`` flag with any of ``anistropy`` command to get more information.
License License
------- =======
GNU GPLv3 GNU GPLv3

7
anisotropy/__init__.py
View File

@ -3,10 +3,15 @@
# License: GNU GPL version 3, see the file "LICENSE" for details. # License: GNU GPL version 3, see the file "LICENSE" for details.
"""anisotropy """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" __license__ = "GPL3"
__version__ = "1.1.0" __version__ = "1.2.0"
__author__ = __maintainer__ = "George Kusayko" __author__ = __maintainer__ = "George Kusayko"
__email__ = "gkusayko@gmail.com" __email__ = "gkusayko@gmail.com"

17
docs/source/README.rst
View File

@ -1,7 +1,7 @@
anisotropy 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. on the anisotropy of permeability in the periodic porous media.
A project uses own wrappers around external applications A project uses own wrappers around external applications
for constructing a shapes and meshes (``Salome``) and computing a flow (``OpenFOAM``). 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 :align: center
:alt: :alt:
.. contents:: Table of contents .. contents:: README contents
Dependencies Dependencies
------------ ============
.. csv-table:: .. csv-table::
:header: "Software", "Used version", "Recommended version" :header: "Software", "Used version", "Recommended version"
@ -28,16 +28,13 @@ Dependencies
"`Salome <https://www.salome-platform.org>`_", "9.7.0", ">= 9.6.0" "`Salome <https://www.salome-platform.org>`_", "9.7.0", ">= 9.6.0"
"`OpenFOAM <https://www.openfoam.com>`_", "v2012", "" "`OpenFOAM <https://www.openfoam.com>`_", "v2012", ""
Installation
------------
.. toctree:: .. Installation
:maxdepth: 2
Installation guide <INSTALL.rst> .. include:: INSTALL.rst
Getting Started Getting Started
--------------- ===============
Initializing a new anisotropy project 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. You always can use ``--help`` flag with any of ``anistropy`` command to get more information.
License License
------- =======
GNU GPLv3 GNU GPLv3

3
docs/source/index.rst
View File

@ -8,8 +8,9 @@ Welcome to anisotropy's documentation!
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Documentation contents:
INSTALL
anisotropy anisotropy
notes notes