Version 2.0.0 upload

README.md

@@ -5,6 +5,11 @@ viewed online at [dtocean.github.io](https://dtocean.github.io/), read as pdf
 documentation or installed for offline use with the DTOcean graphical interface
 (see [dtocean](https://github.com/DTOcean/dtocean)).
 
+**Version 2.0.0 of the manuals is a rewrite of the original release, focussed 
+on the current version of the software, rather than the goals the original EU
+DTOcean project. This process is not not yet fully complete, so please refer to 
+version 1.0.0 when additional detail is required.**
+
 ## Offline Manuals 
 
 The DTOcean Manuals installation wizard can be downloaded from the [Releases](
@@ -41,6 +46,9 @@ and packaged by:
 It is now maintained by Mathew Topper at [Data Only Greater](
 https://www.dataonlygreater.com/).
 
+Gratitude is given to [Sandia Nation Labs](https://www.sandia.gov) for 
+supporting the ongoing rewrite of this documentation.
+
 ## License
 
 [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)

conf.py

@@ -68,24 +68,24 @@
 
 # General information about the project.
 project = u'DTOcean'
-copyright = u'2016 The DTOcean Developers'
+copyright = u'2016-{} The DTOcean Developers'.format(now.year)
 author = u'unknown'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'1.0'
+version = u'2.0'
 # The full version, including alpha/beta/rc tags.
-release = u'1.0.0'
+release = u'2.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = "en"
+language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -96,24 +96,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build',
+                    'data',
                     'contents.rst',
-                    'technical/hydrodynamics.rst',
-                    'technical/electrical.rst',
-                    'technical/moorings.rst',
-                    'technical/instalation.rst',
-                    'technical/operations.rst',
-                    'technical/economics.rst',
-                    'technical/reliability.rst',
-                    'technical/environment.rst',
-                    'user/hydrodynamics.rst',
-                    'user/electrical.rst',
-                    'user/moorings.rst',
-                    'user/installation.rst',
-                    'user/operations.rst',
-                    'user/economics.rst',
-                    'user/reliability.rst',
-                    'user/environment.rst']
-
+                    'user/database_tables.rst']
+
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
 #default_role = None
@@ -250,6 +236,7 @@
 
 ADDITIONAL_PREAMBLE = """
 \setcounter{tocdepth}{4}
+\DeclareUnicodeCharacter{3003}{---"---}
 """
 
 latex_elements = {
@@ -264,9 +251,6 @@
 
     # Latex figure (float) alignment
     #'figure_align': 'htbp',
-
-    # Use extended UTF8 character set
-    'inputenc': "\\usepackage[utf8x]{inputenc}"
     }
 
 # Grouping the document tree into LaTeX files. List of tuples

contents.rst

@@ -2,31 +2,13 @@ Contents
 ========
 
 .. toctree::
-    :maxdepth: 1
-    :numbered:
-    :caption: User's Manual
-
-    user/abstract
-    user/sysreq
-    user/softinstall
-    user/overview
-    user/gui
-    user/modules
-    user/themes
-    user/preprocessing
-    user/references
+   :maxdepth: 1
+   :numbered:
+   :caption: User Guide
 
-.. toctree::
-    :maxdepth: 1
-    :numbered:
-    :caption: Technical Manual
-
-    technical/introduction
-    technical/sysreq
-    technical/designreq
-    technical/datamanagement
-    technical/mainapp
-    technical/database
-    technical/modules
-    technical/themes
-    technical/datastructures
+   user/intro
+   user/install
+   user/getting_started_1
+   user/getting_started_2
+   user/gui
+   user/data_preparation

data/about_menu_table.csv

@@ -0,0 +1,4 @@
+Name,Purpose,Icon
+Index...,Open the user manual (if installed),|icon_manual|
+View Logs...,Open the directory containing the log files,
+About DTOcean...,Open the About dialogue,

data/about_menu_table.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+# Usage:
+# > activate _pytablewriter
+# > cd E:\Programming\Sphinx\git\dtocean.github.io\data
+# > python about_menu_table.py > about_menu_table.rst
+
+import pytablewriter
+from pytablewriter import Align
+
+if __name__ == "__main__":
+    writer = pytablewriter.RstGridTableWriter()
+    writer.from_csv("about_menu_table.csv")
+    writer.write_table()

data/context_menu_table.csv

@@ -0,0 +1,4 @@
+Name,Sections,Branches,Purpose
+Inspect,"Configuration, Results",Modules,Update the output variable values to the state following execution of the selected module
+Reset,Configuration,Modules,"Reset modules and variables to the state prior to execution of the selected module. Note, this action is destructive and cannot be undone."
+Load test data...,Configuration,"Modules, Assessment",Load data from a specifically formatted python file into the variables of the selected branch

data/context_menu_table.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+# Usage:
+# > activate _pytablewriter
+# > cd E:\Programming\Sphinx\git\dtocean.github.io\data
+# > python context_menu_table.py > context_menu_table.rst
+
+import pytablewriter
+from pytablewriter import Align
+
+if __name__ == "__main__":
+    writer = pytablewriter.RstGridTableWriter()
+    writer.from_csv("context_menu_table.csv")
+    writer.write_table()

data/data_menu_table.csv

@@ -0,0 +1,9 @@
+Name,Purpose,Icon
+Select Database...,Open the select database dialogue,|icon_select_db|
+Initiate Pipeline,Confirm chosen technology type and collect top level  information from the database (if selected),|icon_pipeline|
+Initiate Bathymetry,Allow selection of bathymetry from a site chosen from the database (if selected),|icon_bathymetry|
+Initiate Dataflow,Calculate required variables for technology and module selection and collect available data from database (if selected),|icon_dataflow|
+Export...,Export satisfied data to a datastate file,
+Export (mask outputs)...,Export satisfied data (excluding output variables) to a datastate file,
+Import...,Import a datastate file,
+Import (skip satisfied)...,Import a datastate file but do not overwrite satisfied variables,

data/data_menu_table.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+# Usage:
+# > activate _pytablewriter
+# > cd E:\Programming\Sphinx\git\dtocean.github.io\data
+# > python data_menu_table.py > data_menu_table.rst
+
+import pytablewriter
+from pytablewriter import Align
+
+if __name__ == "__main__":
+    writer = pytablewriter.RstGridTableWriter()
+    writer.from_csv("data_menu_table.csv")
+    writer.write_table()

data/data_widget_table_table.csv

@@ -0,0 +1,4 @@
+Icon,Purpose
+|icon_table_edit|,Toggle the editing mode of the table
+|icon_add_row|,Appends a new row to the bottom of the table
+|icon_remove_row|,Removes the row containing the selected cell

data/data_widget_table_table.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+# Usage:
+# > activate _pytablewriter
+# > cd E:\Programming\Sphinx\git\dtocean.github.io\data
+# > python data_widget_table_table.py > data_widget_table_table.rst
+
+import pytablewriter
+from pytablewriter import Align
+
+if __name__ == "__main__":
+    writer = pytablewriter.RstGridTableWriter()
+    writer.from_csv("data_widget_table_table.csv")
+    writer.write_table()

data/database_credentials_table.csv

@@ -0,0 +1,4 @@
+Name,Purpose
+Add,Add an empty credentials record to the list of credentials
+Delete,Delete the credentials record selected in the list of credentials
+Save,Save to file any modifications to the selected credentials made in the credentials table

data/database_credentials_table.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+# Usage:
+# > activate _pytablewriter
+# > cd E:\Programming\Sphinx\git\dtocean.github.io\data
+# > python database_credentials_table.py > database_credentials_table.rst
+
+import pytablewriter
+from pytablewriter import Align
+
+if __name__ == "__main__":
+    writer = pytablewriter.RstGridTableWriter()
+    writer.from_csv("database_credentials_table.csv")
+    writer.write_table()

data/database_sections_table.csv

@@ -0,0 +1,5 @@
+Section,Description
+All,Every table in the database
+Device,Only tables specific to devices
+Site,Only tables specific to sites
+Other,Only tables specific to reference data

data/database_sections_table.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+# Usage:
+# > activate _pytablewriter
+# > cd E:\Programming\Sphinx\git\dtocean.github.io\data
+# > python database_sections_table.py > database_sections_table.rst
+
+import pytablewriter
+from pytablewriter import Align
+
+if __name__ == "__main__":
+    writer = pytablewriter.RstGridTableWriter()
+    writer.from_csv("database_sections_table.csv")
+    writer.write_table()

data/file_menu_table.csv

@@ -0,0 +1,8 @@
+Name,Purpose,Icon
+New,Create a new project from scratch,|icon_new|
+Open...,Open an existing project file,|icon_open|
+Save,Save the current project to file,|icon_save|
+Save As...,Save the current project using a different file name,
+Properties...,Open the project properties dialogue,
+Close,Close the current project,|icon_close|
+Exit,Leave DTOcean,

data/file_menu_table.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+# Usage:
+# > activate _pytablewriter
+# > cd E:\Programming\Sphinx\git\dtocean.github.io\data
+# > python file_menu_table.py > file_menu_table.rst
+
+import pytablewriter
+from pytablewriter import Align
+
+if __name__ == "__main__":
+    writer = pytablewriter.RstGridTableWriter()
+    writer.from_csv("file_menu_table.csv")
+    writer.write_table()

data/input_indicator_table.csv

@@ -0,0 +1,5 @@
+Icon,Status,Meaning
+|icon_green|,Satisfied,Data for the variable has been entered / outputted
+|icon_red|,Required,Data for the variable has not been entered and is required to execute the module or assessment
+|icon_blue|,Optional,Data for the variable has not been entered but is not required to execute the module or assessment
+|icon_grey|,Unavailable,The module has already been executed and data may not be entered for the variable (but can still be viewed)

data/input_indicator_table.py

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+# Usage:
+# > activate _pytablewriter
+# > cd E:\Programming\Sphinx\git\dtocean.github.io\data
+# > python input_indicator_table.py > input_indicator_table.rst
+
+import pytablewriter
+from pytablewriter import Align
+
+if __name__ == "__main__":
+    writer = pytablewriter.RstGridTableWriter()
+    writer.from_csv("input_indicator_table.csv")
+    writer.align_list = [Align.CENTER, None, None]
+    writer.write_table()

data/log_format_table.csv

@@ -0,0 +1,5 @@
+Name,Purpose
+DATETIME,The date and time of the message
+LEVEL,"The logging level of the message. Can be DEBUG, INFO, WARNING, ERROR, or CRITICAL"
+ADDRESS,The package and (python) module that generated the message
+MESSAGE,The contents of the message itself

data/log_format_table.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+# Usage:
+# > activate _pytablewriter
+# > cd E:\Programming\Sphinx\git\dtocean.github.io\data
+# > python log_format_table.py > log_format_table.rst
+
+import pytablewriter
+from pytablewriter import Align
+
+if __name__ == "__main__":
+    writer = pytablewriter.RstGridTableWriter()
+    writer.from_csv("log_format_table.csv")
+    writer.write_table()

data/simulation_menu_table.csv

@@ -0,0 +1,7 @@
+Name,Purpose,Icon
+Add Modules...,Open the module selection shuttle,|icon_modules|
+Add Assessment...,Open the assessment selection shuttle,|icon_assessment|
+Select Strategy...,Open the strategy selection dialogue,|icon_strategy|
+Run Current Module,Execute the next module in the sequence,|icon_run_module|
+Run Assessments,Execute all assessments for the last executed module,|icon_run_assessments|
+Run Strategy,Execute the selected strategy,|icon_run_strategy|

data/simulation_menu_table.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+# Usage:
+# > activate _pytablewriter
+# > cd E:\Programming\Sphinx\git\dtocean.github.io\data
+# > python simulation_menu_table.py > simulation_menu_table.rst
+
+import pytablewriter
+from pytablewriter import Align
+
+if __name__ == "__main__":
+    writer = pytablewriter.RstGridTableWriter()
+    writer.from_csv("simulation_menu_table.csv")
+    writer.write_table()

data/tidal_example_inputs_table.csv

@@ -0,0 +1,14 @@
+Branch,Variable,Value
+Hydrodynamics,Array Rated Power,4.8
+Hydrodynamics,Tidal Probability Bins,12
+Hydrodynamics,Lease Area Boundary Padding,100
+Hydrodynamics,Minimum Q-Factor,0.9
+Hydrodynamics,Power Histogram Bin Width,0.04
+Hydrodynamics,User Option for Array Layout,Staggered
+Electrical Sub-Systems,Network Configuration,Radial
+Electrical Sub-Systems,Maximum Seabed Gradient,14
+Mooring and Foundations,Foundation Safety Factor,1
+Mooring and Foundations,Grout Strength Safety Factor,1
+Mooring and Foundations,Concrete Cost per kg,0.05
+Mooring and Foundations,Grout Cost per kg,0.05
+Mooring and Foundations,Steel Cost per kg,5

data/tidal_example_inputs_table.py

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+# Usage:
+# > activate _pytablewriter
+# > cd E:\Programming\Sphinx\git\dtocean.github.io\data
+# > python tidal_example_inputs_table.py > tidal_example_inputs_table.rst
+
+import pytablewriter
+from pytablewriter import Align
+
+if __name__ == "__main__":
+    writer = pytablewriter.RstGridTableWriter()
+    writer.from_csv("tidal_example_inputs_table.csv")
+    writer.align_list = [None, None, Align.RIGHT]
+    writer.write_table()

data/tools_menu_table.csv

@@ -0,0 +1,3 @@
+Name,Purpose,Icon
+WEC Simulator,Open the WEC hydrodynamics pre-processing tool,|icon_empty|
+Constraints Plot,Calculate and plot constraints to the electrical network layout,