Update documentation

- Remove GUI!
camilledub · Jan 9, 2018 · 010fbfc · 010fbfc
1 parent e31f54f
commit 010fbfc
Show file tree

Hide file tree

Showing 115 changed files with 9,582 additions and 10,693 deletions.
diff --git a/doc/Makefile b/doc/Makefile
@@ -47,7 +47,7 @@ help:
 
 
 api:
-	$(SPHINXBUILDAPI) -f -o source/api -T -H 'PyTurbSim API' ../pyts/
+	$(SPHINXBUILDAPI) -f  -T -H 'PyTurbSim API' -o source/api ../pyts/ ../pyts/gui
 #	$(SPHINXBUILDAPI) -f -o source/api -T -H 'PyTS Plot API' ../pyts_plot/
 
 clean:

diff --git a/doc/source/code-framework.rst b/doc/source/code-framework.rst
@@ -30,7 +30,8 @@ code and its use.  The primary components of this framework are:
       stress profile models.
    d) :mod:`pyts.cohereModels`, contains the spatial
       coherence models.
-   More details on model packages can be found in the :ref:`model-info` section.
+
+  More details on model packages can be found in the :ref:`model-info` section.
 
 3) The :mod:`pyts.io` package supports reading and writing of TurbSim
    input (.inp) and output files (e.g. .bl, .wnd, etc.).

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -63,7 +63,7 @@
 
 # General information about the project.
 project = ver.__prog_name__
-copyright = u'2014, National Renewable Energy Lab'
+copyright = u'2018, National Renewable Energy Lab'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -91,7 +91,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = []
+exclude_patterns = ['pyts/gui/']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 # default_role = None

diff --git a/doc/source/usage.rst b/doc/source/usage.rst
@@ -30,8 +30,8 @@ command line do::
 Alternatively, this mode can be used from an interactive python shell
 by doing::
 
-  >>> from pyts.runInput.main import readConfig, run, write
-  >>> config = readConfig('TurbSim.inp')
+  >>> from pyts.runInput.main import readInput, run, write
+  >>> config = readInput('TurbSim.inp')
   >>> tsdat = run(config)
   >>> write(tsdat, config, 'TurbSim')
 
@@ -51,27 +51,14 @@ the statistics of |pyts| output explicitly. This api is the core
 interface of |pyts| (the other two are wrappers).  As a starting point
 for using this interface checkout the :doc:`API documentation <api/pyts>`. Or start
 navigating the api interactively by importing it::
+
    import pyts.api as pyts
 
 More specifically, the :file:`examples/api.py` file includes an
 overview of how to begin using |pyts|. The contents of that file is:
 
 .. literalinclude:: ../../examples/api.py
 
-3) Graphical user interface (GUI)
----------------------------------
-
-The GUI was developed for reading and writing TurbSim input files.
-The gui was designed to help new users of TurbSim in understanding
-and writing input files. The gui can be used to run |pyts| or
-|ots| (if an |ots| executable can be found in path).
-'gTurbSim' can be run from a command line in the |pyts|
-directory::
-
-   $ python gTurbSim.py TurbSim.inp
-
-The source code for this mode is contained in the :mod:`.pyts.gui` package.
-
 
 Reading output files
 --------------------

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f3dcb6ff76ded42a9421f678f2620724
+config: 48e95e86a0231fc25b40451d00c9e8c3
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_images/plotting.png b/docs/_images/plotting.png
diff --git a/docs/_images/plotting2.png b/docs/_images/plotting2.png
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -1,37 +1,39 @@
+
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
-
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-
-    <title>Overview: module code &mdash; PyTurbSim 0.4.7 documentation</title>
-
+    <title>Overview: module code &#8212; PyTurbSim 0.4.8 documentation</title>
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.4.7',
+        VERSION:     '0.4.8',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
       };
     </script>
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
-    <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <link rel="author" title="About these documents" href="../about.html" />
-    <link rel="top" title="PyTurbSim 0.4.7 documentation" href="../index.html" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
 
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
 
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head>
-  <body role="document">  
+  <body>
+
 
     <div class="document">
       <div class="documentwrapper">
@@ -93,26 +95,23 @@ <h3>Related Topics</h3>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
     <form class="search" action="../search.html" method="get">
-      <input type="text" name="q" />
-      <input type="submit" value="Go" />
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
       <input type="hidden" name="check_keywords" value="yes" />
       <input type="hidden" name="area" value="default" />
     </form>
-    <p class="searchtip" style="font-size: 90%">
-    Enter search terms or a module, class or function name.
-    </p>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2014, National Renewable Energy Lab.
+      &copy;2018, National Renewable Energy Lab.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 
     </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -47,7 +47,7 @@ help: @@
     api:
-    	$(SPHINXBUILDAPI) -f -o source/api -T -H 'PyTurbSim API' ../pyts/
+    	$(SPHINXBUILDAPI) -f  -T -H 'PyTurbSim API' -o source/api ../pyts/ ../pyts/gui
     #	$(SPHINXBUILDAPI) -f -o source/api -T -H 'PyTS Plot API' ../pyts_plot/
     clean:
@@ Expand Down @@