docs updates

hydroffice · Jan 11, 2018 · a1f9c24 · a1f9c24
1 parent ecbda2c
commit a1f9c24
Show file tree

Hide file tree

Showing 56 changed files with 122 additions and 88 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -12,6 +12,7 @@ HydrOffice Sound Speed is developed and maintained by:
 
 - `Chen Zhang <mailto:chen.zhang@noaa.gov>`_
 
+- `Matthew Sharr <mailto:matthew.sharr@noaa.gov>`_
 
 Contributors
 ~~~~~~~~~~~~

diff --git a/HISTORY.rst b/HISTORY.rst
@@ -1,6 +1,12 @@
 History
 -------
 
+2018.0.5
+~~~~~~~~
+
+2018-01-10
+
+- Added automated processing setup and other improvements
 
 2017.3.0
 ~~~~~~~~

diff --git a/LICENSE b/LICENSE
@@ -1,5 +1,5 @@
 Copyright Notice and License Terms for: hyo.soundspeed - Sound Speed package for HydrOffice
-Copyright (c) 2016, University of New Hampshire, Center for Coastal and Ocean Mapping. All rights reserved.  
+Copyright (c) 2018, University of New Hampshire, Center for Coastal and Ocean Mapping. All rights reserved.
 Portions of this project were developed under a cooperative agreement with NOAA Coast Survey Development 
 Laboratory, and contain NOAA-developed code in the public domain.
 

diff --git a/docs/_static/aggregate_plot.png b/docs/_static/aggregate_plot.png
diff --git a/docs/_static/database_tab0.png b/docs/_static/database_tab0.png
diff --git a/docs/_static/editor_tab.png b/docs/_static/editor_tab.png
diff --git a/docs/_static/editor_tab0.png b/docs/_static/editor_tab0.png
diff --git a/docs/_static/editor_tab1.png b/docs/_static/editor_tab1.png
diff --git a/docs/_static/editor_tab10.png b/docs/_static/editor_tab10.png
diff --git a/docs/_static/editor_tab11.png b/docs/_static/editor_tab11.png
diff --git a/docs/_static/editor_tab12.png b/docs/_static/editor_tab12.png
diff --git a/docs/_static/editor_tab13.png b/docs/_static/editor_tab13.png
diff --git a/docs/_static/editor_tab14.png b/docs/_static/editor_tab14.png
diff --git a/docs/_static/editor_tab3.png b/docs/_static/editor_tab3.png
diff --git a/docs/_static/editor_tab4.png b/docs/_static/editor_tab4.png
diff --git a/docs/_static/editor_tab5.png b/docs/_static/editor_tab5.png
diff --git a/docs/_static/editor_tab6.png b/docs/_static/editor_tab6.png
diff --git a/docs/_static/editor_tab7.png b/docs/_static/editor_tab7.png
diff --git a/docs/_static/editor_tab8.png b/docs/_static/editor_tab8.png
diff --git a/docs/_static/editor_tab9.png b/docs/_static/editor_tab9.png
diff --git a/docs/_static/existing_setup.png b/docs/_static/existing_setup.png
diff --git a/docs/_static/map_creation.png b/docs/_static/map_creation.png
diff --git a/docs/_static/metadata_at_import.png b/docs/_static/metadata_at_import.png
diff --git a/docs/_static/metadata_button.png b/docs/_static/metadata_button.png
diff --git a/docs/_static/metadata_widget.png b/docs/_static/metadata_widget.png
diff --git a/docs/_static/monitor.png b/docs/_static/monitor.png
diff --git a/docs/_static/monitor_options_casttime.png b/docs/_static/monitor_options_casttime.png
diff --git a/docs/_static/monitor_options_general.png b/docs/_static/monitor_options_general.png
diff --git a/docs/_static/monitor_options_plots.png b/docs/_static/monitor_options_plots.png
diff --git a/docs/_static/monitor_toolbar_manager.png b/docs/_static/monitor_toolbar_manager.png
diff --git a/docs/_static/monitor_toolbar_monitor.png b/docs/_static/monitor_toolbar_monitor.png
diff --git a/docs/_static/monitor_toolbar_views.png b/docs/_static/monitor_toolbar_views.png
diff --git a/docs/_static/save_to_database.png b/docs/_static/save_to_database.png
diff --git a/docs/_static/server_tab0.png b/docs/_static/server_tab0.png
diff --git a/docs/_static/settings0.png b/docs/_static/settings0.png
diff --git a/docs/_static/settings1.png b/docs/_static/settings1.png
diff --git a/docs/_static/settings2.png b/docs/_static/settings2.png
diff --git a/docs/_static/settings3.png b/docs/_static/settings3.png
diff --git a/docs/_static/settings4.png b/docs/_static/settings4.png
diff --git a/docs/_static/settings5.png b/docs/_static/settings5.png
diff --git a/docs/_static/setup_tab.png b/docs/_static/setup_tab.png
diff --git a/docs/_templates/page.html b/docs/_templates/page.html
@@ -4,7 +4,7 @@
 
     <p>
     This document describes the HydrOffice Sound Speed Library and Manager ({{ version }}). For the source code,
-    <a href="https://bitbucket.org/ccomjhc/hyo_soundspeed">go here</a>.
+    <a href="https://github.com/hydroffice/hyo_soundspeed">go here</a>.
     </p>
 
 </div>

diff --git a/docs/conf.py b/docs/conf.py
@@ -41,16 +41,16 @@
 
 # General information about the project.
 project = u'HydrOffice Sound Speed'
-copyright = u'2017, CCOM/JHC,UNH'
+copyright = u'2018, CCOM/JHC,UNH'
 
 # 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 = '2017.6'
+version = '2018.0'
 # The full version, including alpha/beta/rc tags.
-release = '2017.6.20'
+release = '2018.0.5'
 
 numfig = True
 

diff --git a/docs/developer_guide_todolist.rst b/docs/developer_guide_todolist.rst
@@ -4,8 +4,6 @@ Todolist
 Sound Speed
 ^^^^^^^^^^^
 
-* Implement Fugro format
-* Fix too many/few points in DP algorithm
 * Increase GSW use
 
 
@@ -27,6 +25,5 @@ Atlases
 Research
 ^^^^^^^^
 
-* Evaluate when server mode is appropriate
 * Planning tool: how many xbt?
 * Real-time estimation of variability
diff --git a/docs/in_brief.rst b/docs/in_brief.rst
@@ -7,7 +7,7 @@ In brief
 
 The Sound Speed package is part of the `HydrOffice <https://www.hydroffice.org/license/>`_ framework. HydrOffice is
 a research development environment for ocean mapping. It provides a collection of hydro-packages, each of them dealing
-with a specific issue of the field. The main goal is to speed up both algorithms testing and research-2-operation.
+with a specific issue of the field. The main goal is to speed up both algorithms testing and research-to-operation (R2O).
 
 The Sound Speed package provides both a library and an application with functionalities to manage sound speed profiles,
 and to provide pre-processing ocean mapping tools to help bridge the gap between sound speed profiling instrumentation
@@ -60,6 +60,7 @@ Currently implemented features
 
 * Import of several commonly used sensor/file formats:
 
+  * AML (.csv)
   * AOML AMVER-SEAS XBT (.txt)
   * CARIS (.svp)
   * Castaway (.csv)

diff --git a/docs/index.rst b/docs/index.rst
@@ -20,6 +20,6 @@ HydrOffice Sound Speed's documentation
 
 
 .. note::
-	© University of New Hampshire, Center for Coastal and Ocean Mapping, 2017.  All rights reserved.  Portions of this
+	© University of New Hampshire, Center for Coastal and Ocean Mapping, 2018.  All rights reserved.  Portions of this
 	project were developed under a cooperative agreement with NOAA Coast Survey Development Laboratory, and contain
 	NOAA-developed code in the public domain.
diff --git a/docs/supported_formats.rst b/docs/supported_formats.rst
@@ -6,6 +6,7 @@ Supported Formats
 =================================================== ==== =====
                         Format                      Read Write
 =================================================== ==== =====
+AML (.csv)                                          X
 AOML (.txt)                                         X
 CARIS (.svp)                                        X    X
 Castaway (.csv)                                     X

diff --git a/docs/user_manual_how_to_use.rst b/docs/user_manual_how_to_use.rst
@@ -10,4 +10,4 @@ How to use
    user_manual_how_to_use_3_data_monitor
    user_manual_how_to_use_4_list_of_references
 
-.. note:: For some examples on how to use the library: `https://bitbucket.org/ccomjhc/hyo_soundspeed/src/master/examples/ <https://bitbucket.org/ccomjhc/hyo_soundspeed/src/master/examples/>`_
+.. note:: For some examples on how to use the library: `https://github.com/hydroffice/hyo_soundspeed/tree/master/examples <https://github.com/hydroffice/hyo_soundspeed/tree/master/examples>`_