Version

Date

Description

0

2019-01-30

Instructions to documment consultancy projects by Prodisys

In this documentation you can obtain basis for: - Create documantation to develop projects

Documment creation

The docummentation wil be created in any text editor like notepad (block de notas) for windows, vi or kate for linux.

The structure of each doccument is like the example below:

Frist you shoul define the headers, version, date, description of the project-

.. Salome_Axi documentation master file, created by
sphinx-quickstart on Tue Dec  4 11:40:19 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
    ################################################
    Model of Skimming Tank Hocol Toldado field
    ###############################################

:author: Hernando Gasca Garzón

.. tabularcolumns:: | p{32pt} | p{54pt} | p{326pt} |

+-----------+------------+-------------------------------------------------------------------------------------+
| Version   | Date       | Description                                                                         |
+===========+============+=====================================================================================+
|    0      | 2018-12-18 | axisymmetric model Geometry and mesh in Salome - CFd in openFoam                    |
+-----------+------------+-------------------------------------------------------------------------------------+

In this documentation you can obtain basis for:
- Axisymmetric Meshing.
- Turbulence and multiphase fluid modeling.

Then You put the title of the documment with a line === over and under the text, the levels changes as you change the symbol under and over or only under the text, i.e

Principal title:

=========
text 1
=========

Second level title:

--------
text 2
--------

Third level title:

text3
--------

See sphinx tutorials.

Use the command .. code-block and indent the text you want to see as original text code (that you can copy and paste to run).

===============================
PY-A873 Skimming Hocol Toldado
===============================

----------------
Create Geometry
----------------

.. code-block:: bash

    # -*- coding: utf-8 -*-

    ###
    ### This file is generated automatically by SALOME v7.8.0 with dump python functionality
    ###

    import sys
    import salome

    #Parámetros
    #Radio Skimming
    RSk=4.57
    #Altura Mayor skimming
    HSk=6.746
    #Radio tubo  central distribuidor
    RDist=0.305
    #Altura tubo distribuidor central
    HDist=2.1
    #Radio hasta inicio caja de agua
    RIcajaH2O=2.832
    #Longitud caja de agua
    LcajaH2O=1
    #altura caja de agua
    HcajaH2O=0.8

    salome.salome_init()
    theStudy = salome.myStudy

    import salome_notebook
    notebook = salome_notebook.NoteBook(theStudy)
    sys.path.insert( 0, r'/home/hernando')


    ###
    ### GEOM component
    ###

    import GEOM ................

Use toctree command as you see below to insert other .rst files indicating the path directory and the name of the rst file without .rst.

=================
Use on OpenFOAM
=================



    Export UNV file Mesh_1 and copy un /hgasca/OpenFOAM/run/case

.. code-block:: bash

    ideasUnvToFoam Mesh_1.unv .......



.. toctree::
:maxdepth: 2

0.01/p
0.01/alphaair
0.01/alphaoil
0.01/alphawater
0.01/alphas
0.01/epsilon

You could use many times ..toctree, you should assure that the .rst doccuments be in the path

.. toctree::
:maxdepth: 2

system/collapseDict
system/controlDict
system/decomposeParDict
system/fvSchemes
system/fvSolution
system/meshQualityDict
system/setFieldsDict

    ------------
    Actions
    ------------

        manually delete new time Then

    .. code-block:: bash

        checkMesh

    if errors review your mesh

To insert images use ..figure:: path/name.ext

La batería Toldado se encuentra ubicada dentro del bloque Ortega Tetuán, en inmediaciones del municipio de Ortega
en el departamento del Tolima - Colombia, cuyas coordenadas son las siguientes: 3º52’11,75” N, 75º16’56,82” E. Se
muestra la ubicación geográfica del lugar, la cual se obtuvo con la ayuda de la herramienta de Google Earth
(Figura 2).

Para llegar a la batería se debe seguir la ruta Bogotá – Neiva y después del municipio del Guamo tomar la vía hacía
el municipio de Ortega, recorriendo una distancia aproximada de 46 km hasta llegar a Toldado, tal y como se ilustra
en la figura 3.

:Figura 2:

    .. figure:: images/Figura1.png
        :width: 14cm

    Localización batería Toldado

:Figura 3:

    .. figure:: images/Figura3.png
        :width: 14cm

    Ruta desde el Guamo a Batería Toldado

Éstas referencias fueron tomadas del documento “Localización del proyecto” de la Ingeniería conceptual del proyecto.

To insert youtube videos use .. raw: html

.. raw:: html

    <iframe width="560" height="315" src="https://www.youtube.com/embed/UaIvrDWrIWM" frameborder="0" allowfullscreen></iframe>

Folders

Cada proyecto debe almacenarse dentro de docs/source/PROYECTOS con una estructura similar a:

PROYECTOS/
└── AXXX/
    ├── PY-AXXX.rst
    ├── PY-AXXX-results.rst
    ├── images/
    └── _downloads/

PY-AXXX.rst contiene la documentación principal del proyecto y puede referenciar PY-AXXX-results.rst cuando exista documentación específica de resultados.

Las imágenes utilizadas por las páginas RST deben almacenarse en images/. Los documentos descargables, como PDF, DOCX o XLSX, deben almacenarse preferiblemente en _downloads/.

Connection to index.rst

La documentación vigente se encuentra en:

~/Documents/Prodisys/DOCUMENT_R2/docs/

Los archivos fuente de Sphinx están en:

DOCUMENT_R2/
├── docs/
│   ├── source/
│   │   ├── conf.py
│   │   ├── index.rst
│   │   ├── proyectos.rst
│   │   └── PROYECTOS/
│   └── build/
├── tools/
├── deploy.sh
└── .env

Los proyectos se incorporan al índice de proyectos mediante docs/source/proyectos.rst. Por ejemplo:

.. toctree::
   :maxdepth: 2

   PROYECTOS/A843/PY-A843
   PROYECTOS/A873/PY-A873
   PROYECTOS/A898/PY-A898
   PROYECTOS/A910/PY-A910
   PROYECTOS/AXXX/PY-AXXX

HTML creation

Desde:

~/Documents/Prodisys/DOCUMENT_R2/docs/

ejecute:

make html

La documentación HTML se genera en:

~/Documents/Prodisys/DOCUMENT_R2/docs/build/html/

Para realizar una construcción completamente limpia:

make clean
make html

El despliegue vigente de la documentación puede realizarse mediante:

prodisys-docs-deploy

as

index.html

PDF creation

From:

~/hgasca/

Type and enter:

make latexpdf

This creates all the pdf docummentation project you can run into:

~/build/latex

as

PY-AXXX.pdf