Feature/documentation

.gitignore

@@ -16,3 +16,5 @@ extensions/test
 *.so
 notebooks/
 .idea
+mkdocs-venv
+site

docs/adcp_functions.md

@@ -0,0 +1,3 @@
+# ADCP Functions Reference
+
+::: ion_functions.data.adcp_functions

docs/co2_functions.md

@@ -0,0 +1,3 @@
+# CO2 Functions Reference
+
+::: ion_functions.data.co2_functions

docs/ctd_functions.md

@@ -0,0 +1,3 @@
+# CTD Functions Reference
+
+::: ion_functions.data.ctd_functions

docs/do2_functions.md

@@ -0,0 +1,3 @@
+# DOSTA Functions Reference
+
+::: ion_functions.data.do2_functions

docs/flo_functions.md

@@ -0,0 +1,3 @@
+# Fluorometer Functions Reference
+
+::: ion_functions.data.flo_functions

docs/hyd_functions.md

@@ -0,0 +1,3 @@
+# Hydrophone Functions Reference
+
+::: ion_functions.data.hyd_functions

docs/index.md

@@ -0,0 +1,35 @@
+# Ocean Observatories Initiative Ion Functions Documentation
+
+This is documentation for the Ocean Observatories Initiative (OOI) Ion Functions package, which contains code for calculating L1 and L2 properties from OOI L0 observational data. For information on the OOI, visit [the website](https://oceanobservatories.org/). To explore OOI data including fields calculated using these ion functions, visit the [OOI Data Explorer](https://dataexplorer.oceanobservatories.org/). The source code for the Ion Functions module is available on [GitHub](https://github.com/oceanobservatories/ion-functions), and is linked directly throughout the documentation.
+
+The Ion Functions package houses functions to generate various calculated parameters from OOI data parameters. These calculated parameters are calculated at request time by the OOI infrastructure and are delivered to users alongside the rest of the measured parameters for each instrument.
+
+
+## Project layout
+ * `ion_functions`: top level package
+   - `data`: contains many modules for each of the different instruments requiring calculated parameters/
+   - `qc`: contains various quality controls tests and datasets
+   - `test`: contains unit tests for the modules in `data`
+
+## Project documentation
+
+### Reference documentation for each of the ion functions modules.
+  * [ADCP](adcp_functions.md)
+  * [CTD](ctd_functions.md)
+  * [CO2](co2_functions.md)
+  * [DOSTA](do2_functions.md)
+  * [Fluorometer](flo_functions.md)
+  * [Hydrophone](hyd_functions.md)
+  * [Optical Backscatter](obs_functions.md)
+  * [Met](met_functions.md)
+  * [Disolved Gas](msp_functions.md)
+  * [Disolved Nitrogen](nit_functions.md)
+  * [Seismometer](obs_functions.md)
+  * [OPTAA](opt_functions.md)
+  * [pH](ph_functions.md)
+  * [Seafloor Pressure](prs_functions.md)
+  * [Seafloor Hydrothermal Vent](sfl_functions.md)
+  * [Velocity](vel_functions.md)
+  * [WAVSS](wav_functions.md)
+### Quality Control and Testing
+  * [QC information](qc-tests.md)

docs/met_functions.md

@@ -0,0 +1,3 @@
+# Met Functions Reference
+
+::: ion_functions.data.met_functions

docs/msp_functions.md

@@ -0,0 +1,3 @@
+# Dissolved Gas Concentrations Functions Reference
+
+::: ion_functions.data.msp_functions

docs/nit_functions.md

@@ -0,0 +1,3 @@
+# Dissolved Nitrate Concentration Functions Reference
+
+::: ion_functions.data.nit_functions

docs/obs_functions.md

@@ -0,0 +1,3 @@
+# Ocean Bottom Seismometer Functions Reference
+
+::: ion_functions.data.obs_functions

docs/opt_functions.md

@@ -0,0 +1,7 @@
+# OPTAA Functions Reference
+
+::: ion_functions.data.opt_functions
+
+## OPTAA Temperature and Salinity corrections
+
+::: ion_functions.data.opt_functions_tscor

docs/ph_functions.md

@@ -0,0 +1,3 @@
+# pH Functions Reference
+
+::: ion_functions.data.ph_functions

docs/polycals.md

@@ -0,0 +1,5 @@
+<!-- # Polycal Functions Reference
+
+::: ion_functions.data.polycals -->
+
+<!-- This does not work with MkDocs right now! There are issues with introspection in pyx files. -->

docs/prs_functions.md

@@ -0,0 +1,6 @@
+# Seafloor Pressure Functions Reference
+
+::: ion_functions.data.prs_functions
+
+## OTTILT-CCMP correction coefficients
+::: ion_functions.data.prs_functions_ccmp

docs/qc-tests.md

@@ -0,0 +1,9 @@
+# Information on the Quality Controls and Testing for the Ion Functions module
+
+## QC procedures
+Stuff and things
+
+## Tests
+Run the unit tests with `python -m pytest .`.
+
+Other tests...

docs/sfl_functions.md

@@ -0,0 +1,6 @@
+# Hydrothermal Vent Fluid In-situ Chemistry Functions Reference
+
+::: ion_functions.data.sfl_functions
+
+## SFL Calibration Parameters
+::: ion_functions.data.sfl_functions_surface

docs/utility_functions.md

@@ -0,0 +1,5 @@
+# Utility Functions Reference
+
+::: ion_functions.data.generic_functions
+
+::: ion_functions.data.interpolation

docs/vel_functions.md

@@ -0,0 +1,3 @@
+# Velocity Functions Reference
+
+::: ion_functions.data.vel_functions

docs/wav_functions.md

@@ -0,0 +1,3 @@
+# Surface Wave Spectra Functions Reference
+
+::: ion_functions.data.wav_functions