Aquaveo leprovost adcirc

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = harmonica
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/README.txt

@@ -0,0 +1,12 @@
+To build the documentation for harmonica execute the following command in a console:
+
+make <format>
+
+Format is typically "html", but to view all available formats execute the make command with no arguments.
+
+After executing the make command, the output files will be in the build directory. "Index.html"
+(or "Index" with other format extension) is the root of the documentation pages.
+
+Edit the *.rst reStructuredText files in the source directory to change the layout/content/format
+of the pages. Edit the conf.py file in the source directory to change the settings used by Sphinx
+to generate the documentation.

doc/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=harmonica
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

doc/source/Documentation.rst

@@ -0,0 +1,10 @@
+Documentation
+=====================================
+
+.. toctree::
+
+   tidal_database
+   tidal_constituents
+   adcirc_database
+   leprovost_database
+   resource

doc/source/Installation.rst

@@ -0,0 +1,6 @@
+.. _Installation:
+
+Installation
+=====================================
+
+TODO: Provide steps for installing the harmonica package.

doc/source/Tutorials.rst

@@ -0,0 +1,6 @@
+Tutorials
+=====================================
+
+.. toctree::
+
+   simple_python

doc/source/adcirc_database.rst

@@ -0,0 +1,13 @@
+harmonica.adcirc_database Module
+=====================================
+
+This module is used to extract amplitude and phase tidal harmonics from the
+ADCIRC tidal database. NOAA constituent speeds are also provided (https://tidesandcurrents.noaa.gov).
+This module can also extract the frequency, earth tidal reduction factor, amplitude, nodal factor,
+and equilibrium argument for specified constituents at a specified time. ADCIRC provides two
+tidal databases, one for the Northwest Atlantic and one for Northeast Pacific. Specify
+the appropriate location on construction.
+
+.. automodule:: harmonica.adcirc_database
+   :members:
+   :noindex:

doc/source/conf.py

@@ -0,0 +1,168 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+import sys
+# sys.path.insert(0, os.path.abspath('.'))
+sys.path.append("C:\\Users\\aclark\\AppData\\Local\\conda\\conda\\envs\\harmonica\\Lib\\site-packages")
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'harmonica'
+copyright = '2018, Kevin Winters'
+author = 'Kevin Winters'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.napoleon'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# 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 = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'harmonicadoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'harmonica.tex', 'harmonica Documentation',
+     'Kevin Winters', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'harmonica', 'harmonica Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'harmonica', 'harmonica Documentation',
+     author, 'harmonica', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}

doc/source/index.rst

@@ -0,0 +1,28 @@
+.. harmonica documentation master file, created by
+   sphinx-quickstart on Thu Sep 20 17:01:36 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to harmonica's documentation!
+=====================================
+
+harmonica is an API and CLI to get amplitude, phase, and speed of tidal harmonics 
+from various tidal models. harmonica currently supports TPXO (versions 7.2, 8, and 9),
+ADCIRC, and LeProvost. Also provides functionality to build water surface time series
+utilizing pytides reconstruction and access to pytides deconstruction.
+
+.. toctree::
+   :maxdepth: 1
+
+   Installation
+   Documentation
+   Tutorials
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/source/leprovost_database.rst

@@ -0,0 +1,11 @@
+harmonica.leprovost_database Module
+=====================================
+
+This module is used to extract amplitude and phase tidal harmonics from the
+LeProvost tidal database. NOAA constituent speeds are also provided (https://tidesandcurrents.noaa.gov).
+This module can also provide the frequency, earth tidal reduction factor, amplitude,
+nodal factor, and equilibrium argument for specified constituents at a specified time.
+
+.. automodule:: harmonica.leprovost_database
+   :members:
+   :noindex:

doc/source/resource.rst

@@ -0,0 +1,6 @@
+harmonica.resource Module
+=====================================
+
+.. automodule:: harmonica.resource
+   :members:
+   :noindex: