.. 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. ################################################ Instructive to document in Prodisys consultace ################################################ :author: Hernando Gasca Garzón .. tabularcolumns:: | p{32pt} | p{54pt} | p{326pt} | +-----------+------------+-------------------------------------------------------------------------------------+ | 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- .. code-block:: bash .. 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: .. code-block:: bash ========= text 1 ========= Second level title: .. code-block:: bash -------- text 2 -------- Third level title: .. code-block:: bash text3 -------- See sphinx tutorials. - http://www.sphinx-doc.org/es/stable/tutorial.html 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). .. code-block:: bash =============================== 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. .. code-block:: bash ================= 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 .. code-block:: bash .. 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 .. code-block:: bash 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 .. code-block:: bash .. raw:: html ---------- Folders ---------- You have to create a directory of the project with the structure: - /PYXXX - /PYXXX/PY-AXXX.rsr (for the procedural docummentation) - /PYXXX/PY-AXXX-results.rst (for the presentation docummentation) - /PYXXX/images/ (subforder) - /PYXXX/other (subfoders) In the PY-AXXX.rst you should reference the file PY-AXXX-results.rst In the PY-AXXX-results.rst you should reference the images and other embeeded documments. -------------------------- Connection to index.rst -------------------------- The path for docummentation is: .. code-block:: bash ~/1_prodisys/Documentos/docs/ /Documentos/conf.py (Configuration of the Prodisys docummentation sphinx project) /Documentos/docs/ /Documentos/docs/source/index.rst /Documentos/docs/source/AXXX/ /Documentos/docs/build/ into the file index.rst you should refer the new project as: .. code-block:: bash .. toctree:: :maxdepth: 2 A843/PY-A843 A873/PY-A873 A910/PY-A910 A911/PY-A911 A912/PY-A912 A917/PY-A917 A919/PY-A919 AXXX/PY-AXXX UTIL/utilidades In order to view it into the index.html -------------- HTML creation -------------- From: .. code-block:: bash ~/1_prodisys/Documentos/docs/ Type and enter: .. code-block:: bash make html This creates all the html docummentation project you can run into: .. code-block:: bash ~/1_prodisys/Documentos/docs/build/html as .. code-block:: bash index.html -------------- PDF creation -------------- From: .. code-block:: bash ~/hgasca/ Type and enter: .. code-block:: bash make latexpdf This creates all the pdf docummentation project you can run into: .. code-block:: bash ~/build/latex as .. code-block:: bash PY-AXXX.pdf