Mod: documentation improved

INSTALL.rst

@@ -1,3 +1,64 @@
 Installation
 ============
 
+Recommended way is to install a package in the virtual environment. 
+Just create and activate python virtual environment:
+
+.. code-block:: bash
+
+    $ python -m venv env
+    $ source env/bin/activate
+
+and run pip inside (upgrade pip if you need):
+
+.. code-block:: bash
+
+    (env) $ python -m pip install --upgrade pip
+    (env) $ python -m pip install .
+
+External applications
+---------------------
+
+Anisotropy project requires ``Salome`` and ``OpenFOAM`` executables be ``PATH``.
+
+1. For simple way you can use next commands (each time):
+
+.. code-block:: bash
+
+    $ export PATH="${PATH}:${HOME}/PATH/TO/SALOME/DIRECTORY"
+    $ source "${HOME}/PATH/TO/OPENFOAM/DIRECTORY/etc/bashrc"
+
+2. Or modify file ``conf/bashrc`` in project directory (example)
+
+.. code-block:: bash
+
+    export PATH="${PATH}:${HOME}/programs/salome/SALOME-9.7.0-MPI"
+    source "${HOME}/programs/OpenFOAM/OpenFOAM-v2012/etc/bashrc"
+
+and source it (each time):
+
+.. code-block:: bash
+
+    $ source conf/bashrc
+
+3. The best way is modify file like in step 2 and append it to virtual environment activate script:
+
+.. code-block:: bash
+
+    $ cat conf/bashrc | tee -a env/bin/activate
+
+So next time you just need to ``source env/bin/activate`` and you completely ready.
+
+Building documentaion
+---------------------
+
+For building documentaion you must sure that all requirements installed.
+Project uses ``Sphinx`` and ``make`` for building:
+
+.. code-block:: bash
+
+    $ source env/bin/activate
+    (env) $ cd docs
+    (env) $ make html
+
+

README.rst

@@ -1,22 +1,24 @@
 anisotropy
-===============
+==========
 
 Requirements
 ------------
 
-* python 3.5>
+.. csv-table:: Requirements
-* OpenFOAM
+    :header: "Software", "Used version", "Recommended version"
-* SALOME
-* ParaView
 
-Running
+    "Python", "3.9.6", "> 3.6"
--------
+    "Salome", "9.7.0", "> 9.6.0"
+    "OpenFOAM", "v2012", ""
 
-*in progress*
+Installation
+------------
+
+For installation guide see ``INSTALL``.
 
 License
 -------
 
 GNU GPLv3
 
-For more information see ``LICENSE`` file in this repository.
+For more information see ``LICENSE``.

anisotropy/core/cli.py

@@ -203,26 +203,6 @@ def computemesh(root, type, direction, theta):
 
     model.genmesh()
 
-
-@anisotropy.command(
-    help = """Build documentation
-    
-    TARGET is the builder to use (default: html)
-    """
-)
-@click.argument(
-    "target",
-    default = "html"
-)
-def docs(target):
-    from sphinx.cmd.make_mode import run_make_mode
-    from anisotropy import env
-
-    sourcepath = os.path.join(env["DOCS"], "source")
-    buildpath = os.path.join(env["DOCS"], "build")
-
-    run_make_mode([target, sourcepath, buildpath])
-
 ###
 #   CLI entry
 ##

docs/source/INSTALL.rst

@@ -1,3 +1,64 @@
 Installation
 ============
 
+Recommended way is to install a package in the virtual environment. 
+Just create and activate python virtual environment:
+
+.. code-block:: bash
+
+    $ python -m venv env
+    $ source env/bin/activate
+
+and run pip inside (upgrade pip if you need):
+
+.. code-block:: bash
+
+    (env) $ python -m pip install --upgrade pip
+    (env) $ python -m pip install .
+
+External applications
+---------------------
+
+Anisotropy project requires ``Salome`` and ``OpenFOAM`` executables be ``PATH``.
+
+1. For simple way you can use next commands (each time):
+
+.. code-block:: bash
+
+    $ export PATH="${PATH}:${HOME}/PATH/TO/SALOME/DIRECTORY"
+    $ source "${HOME}/PATH/TO/OPENFOAM/DIRECTORY/etc/bashrc"
+
+2. Or modify file ``conf/bashrc`` in project directory (example)
+
+.. code-block:: bash
+
+    export PATH="${PATH}:${HOME}/programs/salome/SALOME-9.7.0-MPI"
+    source "${HOME}/programs/OpenFOAM/OpenFOAM-v2012/etc/bashrc"
+
+and source it (each time):
+
+.. code-block:: bash
+
+    $ source conf/bashrc
+
+3. The best way is modify file like in step 2 and append it to virtual environment activate script:
+
+.. code-block:: bash
+
+    $ cat conf/bashrc | tee -a env/bin/activate
+
+So next time you just need to ``source env/bin/activate`` and you completely ready.
+
+Building documentaion
+---------------------
+
+For building documentaion you must sure that all requirements installed.
+Project uses ``Sphinx`` and ``make`` for building:
+
+.. code-block:: bash
+
+    $ source env/bin/activate
+    (env) $ cd docs
+    (env) $ make html
+
+

docs/source/anisotropy.rst

@@ -1,4 +1,4 @@
-anisotropy package
+Anisotropy package
 ==================
 
 Subpackages

docs/source/conf.py

@@ -52,3 +52,6 @@ html_theme = 'sphinx_rtd_theme'
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['static']
+html_css_files = [
+    "static/style.css"
+]

docs/source/index.rst

@@ -12,6 +12,7 @@ Welcome to anisotropy's documentation!
 
     INSTALL
     anisotropy
+    notes
 
 .. include:: ../../README.rst
 

docs/source/modules.rst

@@ -1,9 +0,0 @@
-anisotropy
-==========
-
-.. toctree::
-   :maxdepth: 4
-
-   anisotropy
-   setup
-   tests

docs/source/notes.rst

@@ -0,0 +1,7 @@
+Notes
+=====
+
+.. toctree::
+    :glob:
+
+    notes/*

docs/source/notes/database.rst

@@ -0,0 +1,6 @@
+Database hierarchy
+==================
+
+Current anisotropy database hierarchy:
+
+.. image:: ../static/er-diagram.png

docs/source/notes/images.rst

@@ -1,11 +1,15 @@
 Usefull command for making images
 =================================
 
+For database ER diagram (``peewee_erd``):
+
 .. code-block:: python
 
     from peewee_erd import draw
     draw(["anisotropy/core/models.py"], "docs/source/static/er-diagram.svg", "#333333", "#eeeeee", 12, False, False)
 
+For project structure (``pydeps``):
+
 .. code-block:: bash
     
-    pydeps anisotropy --max-bacon 2 --cluster -o docs/source/static/deps.svg --noshow
+    pydeps anisotropy --max-bacon 2 --cluster -o docs/source/static/deps.svg -T svg --noshow

docs/source/notes/mesh.rst

@@ -11,7 +11,6 @@ The main goal for the current meshes is to achieve the following points:
 Example:
 
 .. code-block:: python
-    :linenos:
 
     shape, groups = simple(0.28, True, [1, 0, 0])
     lengths = [ geompy.BasicProperties(edge)[0] for edge in geompy.SubShapeAll(shape, geompy.ShapeType["EDGE"]) ]

docs/source/notes/netgen.rst

@@ -1,6 +1,5 @@
-===============
+Salome Netgen parameters
-Mesh generation
+========================
-===============
 
 .. ``netgen parameters``
     minSize  

docs/source/notes/of-tools.rst

@@ -1,3 +1,5 @@
+OpenFOAM usefull utils
+======================
 
 - createPatch
 - polyDualMesh

docs/source/notes/sphinx.rst

@@ -0,0 +1,8 @@
+Sphinx apidoc and build
+=======================
+
+.. code-block:: bash
+
+    $ sphinx-apidoc -o docs/source/ ./
+    $ cd docs
+    $ make html

docs/source/notes/structure.rst

@@ -0,0 +1,6 @@
+Anisotropy package structure
+============================
+
+Current anisotropy project structure:
+
+.. image:: ../static/structure.png

docs/source/setup.rst

@@ -1,7 +0,0 @@
-setup module
-============
-
-.. automodule:: setup
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/static/er-diagram

@@ -0,0 +1,591 @@
+digraph erd {
+    fontname = "Helvetica"
+    fontsize = 12
+    splines = true
+    node [
+        shape = "plaintext"
+    ]
+    
+        "BaseModel"
+        [label=<
+            <TABLE BGCOLOR="#eeeeee" BORDER="0" CELLBORDER="0" CELLSPACING="0">
+            <TR><TD COLSPAN="2" CELLPADDING="6.0" ALIGN="CENTER" BGCOLOR="#333333">
+            <FONT FACE="Helvetica Bold" COLOR="white">
+            BaseModel
+            </FONT></TD></TR>
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="id">
+            <FONT COLOR="#333333" FACE="Helvetica">id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">AutoField</FONT>
+            </TD></TR>'''
+            
+            </TABLE>
+        >]
+    
+        "Flow"
+        [label=<
+            <TABLE BGCOLOR="#eeeeee" BORDER="0" CELLBORDER="0" CELLSPACING="0">
+            <TR><TD COLSPAN="2" CELLPADDING="6.0" ALIGN="CENTER" BGCOLOR="#333333">
+            <FONT FACE="Helvetica Bold" COLOR="white">
+            Flow
+            </FONT></TD></TR>
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="flow_id">
+            <FONT COLOR="#333333" FACE="Helvetica">flow_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">AutoField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="structure_id">
+            <FONT COLOR="#333333" FACE="Helvetica">structure_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">ForeignKeyField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="scale">
+            <FONT COLOR="#333333" FACE="Helvetica">scale</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">ListField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="pressure">
+            <FONT COLOR="#333333" FACE="Helvetica">pressure</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">JSONField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="velocity">
+            <FONT COLOR="#333333" FACE="Helvetica">velocity</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">JSONField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="transportProperties">
+            <FONT COLOR="#333333" FACE="Helvetica">transportProperties</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">JSONField</FONT>
+            </TD></TR>'''
+            
+            </TABLE>
+        >]
+    
+        "FlowApproximation"
+        [label=<
+            <TABLE BGCOLOR="#eeeeee" BORDER="0" CELLBORDER="0" CELLSPACING="0">
+            <TR><TD COLSPAN="2" CELLPADDING="6.0" ALIGN="CENTER" BGCOLOR="#333333">
+            <FONT FACE="Helvetica Bold" COLOR="white">
+            FlowApproximation
+            </FONT></TD></TR>
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="flow_approximation_id">
+            <FONT COLOR="#333333" FACE="Helvetica">flow_approximation_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">AutoField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="flow_id">
+            <FONT COLOR="#333333" FACE="Helvetica">flow_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">ForeignKeyField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="pressure">
+            <FONT COLOR="#333333" FACE="Helvetica">pressure</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">JSONField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="velocity">
+            <FONT COLOR="#333333" FACE="Helvetica">velocity</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">JSONField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="transportProperties">
+            <FONT COLOR="#333333" FACE="Helvetica">transportProperties</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">JSONField</FONT>
+            </TD></TR>'''
+            
+            </TABLE>
+        >]
+    
+        "FlowResult"
+        [label=<
+            <TABLE BGCOLOR="#eeeeee" BORDER="0" CELLBORDER="0" CELLSPACING="0">
+            <TR><TD COLSPAN="2" CELLPADDING="6.0" ALIGN="CENTER" BGCOLOR="#333333">
+            <FONT FACE="Helvetica Bold" COLOR="white">
+            FlowResult
+            </FONT></TD></TR>
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="flowresult_id">
+            <FONT COLOR="#333333" FACE="Helvetica">flowresult_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">AutoField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="flow_id">
+            <FONT COLOR="#333333" FACE="Helvetica">flow_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">ForeignKeyField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="flowRate">
+            <FONT COLOR="#333333" FACE="Helvetica">flowRate</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="status">
+            <FONT COLOR="#333333" FACE="Helvetica">status</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">TextField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="calculationTime">
+            <FONT COLOR="#333333" FACE="Helvetica">calculationTime</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">TimeField</FONT>
+            </TD></TR>'''
+            
+            </TABLE>
+        >]
+    
+        "Mesh"
+        [label=<
+            <TABLE BGCOLOR="#eeeeee" BORDER="0" CELLBORDER="0" CELLSPACING="0">
+            <TR><TD COLSPAN="2" CELLPADDING="6.0" ALIGN="CENTER" BGCOLOR="#333333">
+            <FONT FACE="Helvetica Bold" COLOR="white">
+            Mesh
+            </FONT></TD></TR>
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="mesh_id">
+            <FONT COLOR="#333333" FACE="Helvetica">mesh_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">AutoField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="structure_id">
+            <FONT COLOR="#333333" FACE="Helvetica">structure_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">ForeignKeyField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="maxSize">
+            <FONT COLOR="#333333" FACE="Helvetica">maxSize</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="minSize">
+            <FONT COLOR="#333333" FACE="Helvetica">minSize</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="fineness">
+            <FONT COLOR="#333333" FACE="Helvetica">fineness</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">IntegerField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="growthRate">
+            <FONT COLOR="#333333" FACE="Helvetica">growthRate</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="nbSegPerEdge">
+            <FONT COLOR="#333333" FACE="Helvetica">nbSegPerEdge</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="nbSegPerRadius">
+            <FONT COLOR="#333333" FACE="Helvetica">nbSegPerRadius</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="chordalErrorEnabled">
+            <FONT COLOR="#333333" FACE="Helvetica">chordalErrorEnabled</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="chordalError">
+            <FONT COLOR="#333333" FACE="Helvetica">chordalError</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="secondOrder">
+            <FONT COLOR="#333333" FACE="Helvetica">secondOrder</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="optimize">
+            <FONT COLOR="#333333" FACE="Helvetica">optimize</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="quadAllowed">
+            <FONT COLOR="#333333" FACE="Helvetica">quadAllowed</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="useSurfaceCurvature">
+            <FONT COLOR="#333333" FACE="Helvetica">useSurfaceCurvature</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="fuseEdges">
+            <FONT COLOR="#333333" FACE="Helvetica">fuseEdges</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="checkChartBoundary">
+            <FONT COLOR="#333333" FACE="Helvetica">checkChartBoundary</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="viscousLayers">
+            <FONT COLOR="#333333" FACE="Helvetica">viscousLayers</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="thickness">
+            <FONT COLOR="#333333" FACE="Helvetica">thickness</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="numberOfLayers">
+            <FONT COLOR="#333333" FACE="Helvetica">numberOfLayers</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">IntegerField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="stretchFactor">
+            <FONT COLOR="#333333" FACE="Helvetica">stretchFactor</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="isFacesToIgnore">
+            <FONT COLOR="#333333" FACE="Helvetica">isFacesToIgnore</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="facesToIgnore">
+            <FONT COLOR="#333333" FACE="Helvetica">facesToIgnore</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">ListField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="extrusionMethod">
+            <FONT COLOR="#333333" FACE="Helvetica">extrusionMethod</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">TextField</FONT>
+            </TD></TR>'''
+            
+            </TABLE>
+        >]
+    
+        "MeshResult"
+        [label=<
+            <TABLE BGCOLOR="#eeeeee" BORDER="0" CELLBORDER="0" CELLSPACING="0">
+            <TR><TD COLSPAN="2" CELLPADDING="6.0" ALIGN="CENTER" BGCOLOR="#333333">
+            <FONT FACE="Helvetica Bold" COLOR="white">
+            MeshResult
+            </FONT></TD></TR>
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="meshresult_id">
+            <FONT COLOR="#333333" FACE="Helvetica">meshresult_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">AutoField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="mesh_id">
+            <FONT COLOR="#333333" FACE="Helvetica">mesh_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">ForeignKeyField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="surfaceArea">
+            <FONT COLOR="#333333" FACE="Helvetica">surfaceArea</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="volume">
+            <FONT COLOR="#333333" FACE="Helvetica">volume</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="elements">
+            <FONT COLOR="#333333" FACE="Helvetica">elements</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">IntegerField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="edges">
+            <FONT COLOR="#333333" FACE="Helvetica">edges</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">IntegerField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="faces">
+            <FONT COLOR="#333333" FACE="Helvetica">faces</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">IntegerField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="volumes">
+            <FONT COLOR="#333333" FACE="Helvetica">volumes</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">IntegerField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="tetrahedrons">
+            <FONT COLOR="#333333" FACE="Helvetica">tetrahedrons</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">IntegerField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="prisms">
+            <FONT COLOR="#333333" FACE="Helvetica">prisms</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">IntegerField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="pyramids">
+            <FONT COLOR="#333333" FACE="Helvetica">pyramids</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">IntegerField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="status">
+            <FONT COLOR="#333333" FACE="Helvetica">status</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">TextField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="calculationTime">
+            <FONT COLOR="#333333" FACE="Helvetica">calculationTime</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">TimeField</FONT>
+            </TD></TR>'''
+            
+            </TABLE>
+        >]
+    
+        "Structure"
+        [label=<
+            <TABLE BGCOLOR="#eeeeee" BORDER="0" CELLBORDER="0" CELLSPACING="0">
+            <TR><TD COLSPAN="2" CELLPADDING="6.0" ALIGN="CENTER" BGCOLOR="#333333">
+            <FONT FACE="Helvetica Bold" COLOR="white">
+            Structure
+            </FONT></TD></TR>
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="structure_id">
+            <FONT COLOR="#333333" FACE="Helvetica">structure_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">AutoField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="type">
+            <FONT COLOR="#333333" FACE="Helvetica">type</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">TextField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="direction">
+            <FONT COLOR="#333333" FACE="Helvetica">direction</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">ListField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="theta">
+            <FONT COLOR="#333333" FACE="Helvetica">theta</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="r0">
+            <FONT COLOR="#333333" FACE="Helvetica">r0</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="L">
+            <FONT COLOR="#333333" FACE="Helvetica">L</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="radius">
+            <FONT COLOR="#333333" FACE="Helvetica">radius</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="filletsEnabled">
+            <FONT COLOR="#333333" FACE="Helvetica">filletsEnabled</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="fillets">
+            <FONT COLOR="#333333" FACE="Helvetica">fillets</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            </TABLE>
+        >]
+    
+        "SubMesh"
+        [label=<
+            <TABLE BGCOLOR="#eeeeee" BORDER="0" CELLBORDER="0" CELLSPACING="0">
+            <TR><TD COLSPAN="2" CELLPADDING="6.0" ALIGN="CENTER" BGCOLOR="#333333">
+            <FONT FACE="Helvetica Bold" COLOR="white">
+            SubMesh
+            </FONT></TD></TR>
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="submesh_id">
+            <FONT COLOR="#333333" FACE="Helvetica">submesh_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">AutoField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="mesh_id">
+            <FONT COLOR="#333333" FACE="Helvetica">mesh_id</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">ForeignKeyField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="name">
+            <FONT COLOR="#333333" FACE="Helvetica">name</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">TextField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="maxSize">
+            <FONT COLOR="#333333" FACE="Helvetica">maxSize</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="minSize">
+            <FONT COLOR="#333333" FACE="Helvetica">minSize</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="fineness">
+            <FONT COLOR="#333333" FACE="Helvetica">fineness</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">IntegerField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="growthRate">
+            <FONT COLOR="#333333" FACE="Helvetica">growthRate</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="nbSegPerEdge">
+            <FONT COLOR="#333333" FACE="Helvetica">nbSegPerEdge</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="nbSegPerRadius">
+            <FONT COLOR="#333333" FACE="Helvetica">nbSegPerRadius</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="chordalErrorEnabled">
+            <FONT COLOR="#333333" FACE="Helvetica">chordalErrorEnabled</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="chordalError">
+            <FONT COLOR="#333333" FACE="Helvetica">chordalError</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">FloatField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="secondOrder">
+            <FONT COLOR="#333333" FACE="Helvetica">secondOrder</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="optimize">
+            <FONT COLOR="#333333" FACE="Helvetica">optimize</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="quadAllowed">
+            <FONT COLOR="#333333" FACE="Helvetica">quadAllowed</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="useSurfaceCurvature">
+            <FONT COLOR="#333333" FACE="Helvetica">useSurfaceCurvature</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="fuseEdges">
+            <FONT COLOR="#333333" FACE="Helvetica">fuseEdges</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            <TR><TD CELLPADDING="6.0" ALIGN="LEFT" BORDER="0" PORT="checkChartBoundary">
+            <FONT COLOR="#333333" FACE="Helvetica">checkChartBoundary</FONT>
+            </TD><TD CELLPADDING="6.0" ALIGN="LEFT">
+            <FONT COLOR="#333333" FACE="Helvetica">BooleanField</FONT>
+            </TD></TR>'''
+            
+            </TABLE>
+        >]
+    
+    
+        "Flow":"structure_id" -> "Structure":"structure_id"
+            [arrowhead=empty, arrowtail=none, dir=both];
+    
+        "FlowApproximation":"flow_id" -> "Flow":"flow_id"
+            [arrowhead=empty, arrowtail=none, dir=both];
+    
+        "FlowResult":"flow_id" -> "Flow":"flow_id"
+            [arrowhead=empty, arrowtail=none, dir=both];
+    
+        "Mesh":"structure_id" -> "Structure":"structure_id"
+            [arrowhead=empty, arrowtail=none, dir=both];
+    
+        "MeshResult":"mesh_id" -> "Mesh":"mesh_id"
+            [arrowhead=empty, arrowtail=none, dir=both];
+    
+        "SubMesh":"mesh_id" -> "Mesh":"mesh_id"
+            [arrowhead=empty, arrowtail=none, dir=both];
+    
+    
+}

docs/source/static/style.css

@@ -0,0 +1,3 @@
+svg {
+    width: 100px;
+}

docs/source/tests.rst

@@ -1,29 +0,0 @@
-tests package
-=============
-
-Submodules
-----------
-
-tests.anisotropy\-cli module
-----------------------------
-
-.. automodule:: tests.anisotropy-cli
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-tests.test\_anisotropy module
------------------------------
-
-.. automodule:: tests.test_anisotropy
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: tests
-   :members:
-   :undoc-members:
-   :show-inheritance:

notes/sphinx.rst

@@ -1,9 +0,0 @@
-sphinx
-======
-
-.. code_block:: bash
-    :lineos:
-
-    sphinx-apidoc -o docs/source/ ./
-    cd docs
-    make html

requirements.txt

@@ -1,3 +1,4 @@
+wheel
 numpy
 pyquaternion
 toml