build on travis ci

Author: tcaduser

.travis.yml

@@ -0,0 +1,21 @@
+
+language: minimal
+
+dist: xenial
+#sudo: false
+
+# use apt-file command to find packages
+before_install:
+  - set -e
+  - if [ "$TRAVIS_OS_NAME" == "linux" ]; then
+    sudo apt-get --yes install curl bzip2 make latexmk texlive-latex-recommended texlive-fonts-recommended texlive-latex-extra;
+    curl -O https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh;
+    bash Miniconda3-latest-Linux-x86_64.sh -b -p ${HOME}/anaconda;
+    fi
+
+script:
+  - source ${HOME}/anaconda/bin/activate base
+  - ./preinstall.sh
+  - source activate devsim_doc
+  - ./build.sh
+

README

@@ -1,22 +1,7 @@
-If using anaconda, make sure you have sphinx installed.  And the following package:
-conda install sphinx sphinx_rtd_theme
-pip install sphinxcontrib-bibtex
+Build steps starting with conda in your path.
 
-cd pydoc
-export PYTHONPATH=${PWD}
+preinstall.sh
+source activate devsim_doc
+build.sh
 
-# edit python files
-
-#check results
-(cd pydoc && python CommandDoc.py) && (cd sphinx && make clean && make html)
-open file://${HOME}/git/devsim_manual/sphinx/build/html/CommandReference.html#meshing-commands
-
-cp CommandReference.rst file into sphinx/source directory.
-cp DevsimDoc.cc into devsim directory
-
-cd ../sphinx
-make pdf
-make html
-bash sync.sh
-
-cp devsim.pdf into devsim directory
+The doc directory contains the pdf, html, and c++ file.

README.md

@@ -1,5 +1,7 @@
 # devsim_documentation
 
+[![Build Status](https://travis-ci.org/devsim/devsim_documentation.svg?branch=master)](https://travis-ci.org/devsim/devsim_documentation)
+
 ## Introduction
 
 This is the future location for the DEVSIM Manual and related documentation.  It is currently hosted in pdf and html formats here. https://devsim.net

build.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+set -e
+
+BASEDIR=${PWD}
+PYDIR=${BASEDIR}/pydoc
+SPHINXDIR=${BASEDIR}/sphinx
+SPHINXSOURCE=${SPHINXDIR}/source
+SPHINXBUILD=${SPHINXDIR}/build
+PKGDIR=${BASEDIR}/doc
+export PYTHONPATH=${PYDIR}
+echo ${PYTHONPATH}
+
+cd ${PYDIR}
+echo "Generating Python Documentation"
+python CommandDoc.py
+
+cp -av CommandReference.rst ${SPHINXSOURCE}
+
+cd ${SPHINXDIR}
+make html
+make latexpdf
+
+rm -rf ${PKGDIR}
+mkdir -p ${PKGDIR}
+cp -vR  ${SPHINXBUILD}/html ${PKGDIR}
+cp -v ${SPHINXBUILD}/latex/devsim.pdf ${PKGDIR}
+cp -v ${PYDIR}/DevsimDoc.cc ${PKGDIR}
+

preinstall.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -e
+conda create --yes --name devsim_doc python=3
+source activate devsim_doc
+conda install --yes sphinx sphinx_rtd_theme numpydoc
+pip install sphinxcontrib-bibtex

pydoc/CommandDoc.py

@@ -1,4 +1,4 @@
-import StringIO
+import io
 import commandCommon
 import sys
 
@@ -163,21 +163,21 @@
 def printCppMultiline(ofh, csb):
   s = CppEscape(csb.getvalue())
   for l in s.splitlines():
-    print >>ofh, r'"%s\n"' % l 
+    print(r'"%s\n"' % l, file=ofh) 
 
 
 def printCppCommand(ofh, sectionname, command):
-  for k in command.keys():
+  for k in list(command.keys()):
     if k not in ("name", "description", "long_description", "parameters"):
       raise RuntimeError("Unexpected key: " + k)
   try:
     commandname = command["name"].lower()
 
-    print >>ofh, "\nstatic const char %s_doc[] =" % commandname
-    csb = StringIO.StringIO()
+    print("\nstatic const char %s_doc[] =" % commandname, file=ofh)
+    csb = io.StringIO()
     printPyCommand(csb, sectionname, command, False)
     printCppMultiline(ofh, csb)
-    print >>ofh, ";"
+    print(";", file=ofh)
   except Exception as e:
     #raise RuntimeError("Error while processing commmand: " + commandname + "\n" + str(e))
     raise
@@ -305,7 +305,7 @@ def printPyParameters(ofh, command):
 # Follow guide from https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
 # TODO return values
 def printPyCommand(ofh, sectionname, command, print_def):
-  for k in command.keys():
+  for k in list(command.keys()):
     if k not in ("name", "description", "long_description", "parameters"):
       raise RuntimeError("Unexpected key: " + k)
   try:
@@ -315,7 +315,7 @@ def printPyCommand(ofh, sectionname, command, print_def):
         "commandname" : commandname,
       }
       ofh.write("\ndef %(commandname)s (**kwargs):\n" % mydict)
-    csb = StringIO.StringIO()
+    csb = io.StringIO()
     if print_def:
       csb.write("'''\n")
     printPyCommandString(csb, command)

pydoc/DevsimDoc.cc

@@ -247,9 +247,9 @@ static const char equation_doc[] =
 "    In order to set the node volumes for integration of the ``edge_volume_model``, it is possible to do something like this:\n"
 "\n"
 "    ..\n"
-"      ds.edge_model(device=\"device\", region=\"region\", name=\"EdgeNodeVolume\", equation=\"0.5*SurfaceArea*EdgeLength\")\n"
-"      ds.set_parameter(name=\"edge_node0_volume_model\", value=\"EdgeNodeVolume\")\n"
-"      ds.set_parameter(name=\"edge_node1_volume_model\", value=\"EdgeNodeVolume\")\n"
+"      devsim.edge_model(device=\"device\", region=\"region\", name=\"EdgeNodeVolume\", equation=\"0.5*SurfaceArea*EdgeLength\")\n"
+"      devsim.set_parameter(name=\"edge_node0_volume_model\", value=\"EdgeNodeVolume\")\n"
+"      devsim.set_parameter(name=\"edge_node1_volume_model\", value=\"EdgeNodeVolume\")\n"
 "\n"
 ;
 
@@ -460,7 +460,7 @@ static const char add_db_entry_doc[] =
 "    Notes\n"
 "    -----\n"
 "\n"
-"    The :meth:`ds.save_db` command is used to commit these added entries permanently to the database.\n"
+"    The :meth:`devsim.save_db` command is used to commit these added entries permanently to the database.\n"
 ;
 
 static const char close_db_doc[] =
@@ -554,7 +554,7 @@ static const char get_parameter_list_doc[] =
 "    Notes\n"
 "    -----\n"
 "\n"
-"    Note that the ``device`` and ``region`` options are optional.  If the region is not specified, the parameter is retrieved for the entire device.  If the device is not specified, the parameter is retrieved for all devices.  Unlike the :meth:`ds.getParameter`, parameter names on the the device are not retrieved if they do not exist on the region.  Similarly, the parameter names over all devices are not retrieved if they do not exist on the device.\n"
+"    Note that the ``device`` and ``region`` options are optional.  If the region is not specified, the parameter is retrieved for the entire device.  If the device is not specified, the parameter is retrieved for all devices.  Unlike the :meth:`devsim.getParameter`, parameter names on the the device are not retrieved if they do not exist on the region.  Similarly, the parameter names over all devices are not retrieved if they do not exist on the device.\n"
 ;
 
 static const char open_db_doc[] =
@@ -1106,7 +1106,7 @@ static const char cylindrical_edge_couple_doc[] =
 "    - ``ElementCylindricalEdgeCouple`` (Element Edge Model)\n"
 "    - ``CylindricalEdgeCouple`` (Edge Model)\n"
 "\n"
-"    The :meth:`ds.set_parameter` must be used to set\n"
+"    The :meth:`devsim.set_parameter` must be used to set\n"
 "\n"
 "    - ``raxis_variable``, the variable (``x`` or ``y``) which is the radial axis variable in the cylindrical coordinate system\n"
 "    - ``raxis_zero``, the location of the z axis for the radial axis variable\n"
@@ -1137,7 +1137,7 @@ static const char cylindrical_node_volume_doc[] =
 "\n"
 "    The ``ElementCylindricalNodeVolume@en0`` and ``ElementCylindricalNodeVolume@en1`` represent the node volume at each end of the element edge.\n"
 "\n"
-"    The :meth:`ds.set_parameter` must be used to set\n"
+"    The :meth:`devsim.set_parameter` must be used to set\n"
 "\n"
 "    - ``raxis_variable``, the variable (``x`` or ``y``) which is the radial axis variable in the cylindrical coordinate system\n"
 "    - ``raxis_zero``, the location of the z axis for the radial axis variable\n"
@@ -1165,7 +1165,7 @@ static const char cylindrical_surface_area_doc[] =
 "\n"
 "    and is the cylindrical surface area along each contact and interface node in the device region.\n"
 "\n"
-"    The :meth:`ds.set_parameter` must be used to set\n"
+"    The :meth:`devsim.set_parameter` must be used to set\n"
 "\n"
 "    - ``raxis_variable``, the variable (``x`` or ``y``) which is the radial axis variable in the cylindrical coordinate system\n"
 "    - ``raxis_zero``, the location of the z axis for the radial axis variable\n"
@@ -1272,13 +1272,13 @@ static const char edge_average_model_doc[] =
 "\n"
 "    ..\n"
 "\n"
-"      ds.edge_average_model(device=device, region=region, node_model=\"Potential\", edge_model=\"ElecticField\", average_type=\"negative_gradient\")\n"
+"      devsim.edge_average_model(device=device, region=region, node_model=\"Potential\", edge_model=\"ElecticField\", average_type=\"negative_gradient\")\n"
 "\n"
 "    and the derivatives ``ElectricField:Potential@n0`` and ``ElectricField:Potential@n1`` are then created from\n"
 "\n"
 "    ..\n"
 "\n"
-"      ds.edge_average_model(device=device, region=region, node_model=\"Potential\", edge_model=\"ElecticField\", average_type=\"negative_gradient\", derivative=\"Potential\")\n"
+"      devsim.edge_average_model(device=device, region=region, node_model=\"Potential\", edge_model=\"ElecticField\", average_type=\"negative_gradient\", derivative=\"Potential\")\n"
 ;
 
 static const char edge_from_node_model_doc[] =
@@ -1302,7 +1302,7 @@ static const char edge_from_node_model_doc[] =
 "\n"
 "    ..\n"
 "\n"
-"      ds.edge_from_node_model(device=device, region=region, node_model=\"Potential\")\n"
+"      devsim.edge_from_node_model(device=device, region=region, node_model=\"Potential\")\n"
 "\n"
 ;
 
@@ -1333,7 +1333,7 @@ static const char edge_model_doc[] =
 "    - ``model_y_onNode``\n"
 "    - ``model_z_onNode`` (3D)\n"
 "\n"
-"    This averaging scheme does not produce accurate results, and it is recommended to use the :meth:`ds.element_from_edge_model` to create components better suited for visualization.  See :ref:`ch__visualization` for more information about creating data files for external visualization programs.\n"
+"    This averaging scheme does not produce accurate results, and it is recommended to use the :meth:`devsim.element_from_edge_model` to create components better suited for visualization.  See :ref:`ch__visualization` for more information about creating data files for external visualization programs.\n"
 ;
 
 static const char element_from_edge_model_doc[] =
@@ -1781,7 +1781,7 @@ static const char vector_gradient_doc[] =
 "    - ``model_grady`` (2D and 3D)\n"
 "    - ``model_gradz`` (3D)\n"
 "\n"
-"    It is important not to use these models for simulation, since DEVSIM, does not have a way of evaluating the derivatives of these models.  The models can be used for integrating the impedance field, and other postprocessing.  The :meth:`ds.element_from_edge_model` command can be used to create gradients for use in a simulation.\n"
+"    It is important not to use these models for simulation, since DEVSIM, does not have a way of evaluating the derivatives of these models.  The models can be used for integrating the impedance field, and other postprocessing.  The :meth:`devsim.element_from_edge_model` command can be used to create gradients for use in a simulation.\n"
 ;
 
 static const char get_contact_charge_doc[] =