update published docs

NOAA-ORR-ERD · Oct 12, 2023 · c3d87d7 · c3d87d7
1 parent 16146bc
commit c3d87d7
Show file tree

Hide file tree

Showing 94 changed files with 7,526 additions and 1,232 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_downloads/063da19ee272757d99b8f328b5058b8c/ADIOS_data_template.xlsx b/docs/_downloads/063da19ee272757d99b8f328b5058b8c/ADIOS_data_template.xlsx
diff --git a/docs/_downloads/ae95a1adb2ff0f859d56d1701e310748/product_types_and_labels.csv b/docs/_downloads/ae95a1adb2ff0f859d56d1701e310748/product_types_and_labels.csv
@@ -0,0 +1,24 @@
+This describes which labels can be associated with specific product types,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+Labels can be added as need arises.,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+NOTE: This table will be used to populate the Product Types and Labels System in the software.,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+"Originally Created Sept.18, 2020 by Robert",,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+DATA TABLE:,(data table follows this row),,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+TYPE:,LABEL ->,Crude Oil,Condensate,Light Crude,Medium Crude,Heavy Crude,Dilbit,Synbit,Bitumen,Refined Product,Fuel Oil,Distillate Fuel,Residual Fuel,Jet Fuel,No. 1 Fuel Oil,Gasoline,Kerosene,Aviation Gas,Bio-Fuel,MDO,Diesel,Gas Oil,No. 2 Fuel Oil,Home Heating Oil,IFO,HFO,Heavy Fuel Oil,No. 6 Fuel Oil,Bunker C,Group V,Solvent,Lube Oil,Transformer Oil,Shale Oil,Tight Oil,Fracking Oil,Vacuum Gas Oil,Refinery Intermediate,Natural Plant Oil,Dielectric Oil,Hydraulic Fluid,LSFO,VLSFO,ULSFO
+Crude Oil NOS,,x,,x,x,x,x,x,,,,,,,,,,,,,,,,,,,,,,x,,,,,,,,,,,,,,
+Tight Oil,,x,,x,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,x,x,x,,,,,,,,
+Condensate,,x,x,x,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+Bitumen Blend,,x,,,x,x,x,x,x,,,,,,,,,,,,,,,,,,,,,x,,,,,,,,,,,,,,
+Bitumen,,,,,,,,,x,,,,,,,,,,,,,,,,,,,,,x,,,,,,,,x,,,,,,
+Refined Product NOS,,,,,,,,,,x,x,,x,x,x,x,x,x,,x,x,x,x,x,x,x,x,x,x,x,,,x,,,,,,,,,x,x,x
+Fuel Oil NOS,,,,,,,,,,x,x,,x,x,x,x,x,x,,x,x,x,x,x,x,x,x,x,x,x,,,,,,,,,,,,x,x,x
+Distillate Fuel Oil,,,,,,,,,,x,x,x,,x,x,x,x,x,,x,x,x,x,x,,,,,,,,,,,,,,,,,,x,x,x
+Residual Fuel Oil,,,,,,,,,,x,x,,x,,,,,,,,,,,,x,x,x,x,x,x,,,,,,,,,,,,x,x,x
+Refinery Intermediate,,,,,,,,,,x,,,,,,,x,,,,,,,,,,,,,x,,,,,,,x,x,,,,,,
+Solvent,,,,,,,,,,x,,,,,,,,,,,,,,,,,,,,,x,,,,,,,,,,,,,
+Bio-fuel Oil,,,,,,,,,,x,x,,,x,,,x,x,x,x,x,x,x,x,,,,,,,,,,,,,,,,,,x,x,x
+Bio-Petro Fuel Oil,,,,,,,,,,x,x,x,,x,,,x,x,x,x,x,x,x,x,,,,,,,,,,,,,,,,,,x,x,x
+Natural Plant Oil,,,,,,,,,,x,x,,,,,,,,,,,,,,,,,,,,,,,,,,,,x,,,,,
+Lube Oil,,,,,,,,,,x,,,,,,,,,,,,,,,,,,,,,,x,,,,,,,,,,,,
+Dielectric Oil,,,,,,,,,,x,,,,,,,,,,,,,,,,,,,,,,,x,,,,,,,x,,,,
+Hydraulic Fluid,,,,,,,,,,x,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,x,,,
+Other,,x,,x,x,x,,,x,x,x,,x,x,x,,x,x,,x,x,x,x,x,x,x,,,,,,,x,x,,,x,,,,,,,
diff --git a/docs/_sources/api/adios_db.computation.rst.txt b/docs/_sources/api/adios_db.computation.rst.txt
@@ -0,0 +1,42 @@
+adios\_db.computation package
+=============================
+
+.. automodule:: adios_db.computation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+adios\_db.computation.estimations module
+----------------------------------------
+
+.. automodule:: adios_db.computation.estimations
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.computation.gnome\_oil module
+---------------------------------------
+
+.. automodule:: adios_db.computation.gnome_oil
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.computation.physical\_properties module
+-------------------------------------------------
+
+.. automodule:: adios_db.computation.physical_properties
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.computation.utilities module
+--------------------------------------
+
+.. automodule:: adios_db.computation.utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/api/adios_db.data_sources.env_canada.rst.txt b/docs/_sources/api/adios_db.data_sources.env_canada.rst.txt
@@ -0,0 +1,17 @@
+adios\_db.data\_sources.env\_canada package
+===========================================
+
+.. automodule:: adios_db.data_sources.env_canada
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   adios_db.data_sources.env_canada.v1
+   adios_db.data_sources.env_canada.v2
+   adios_db.data_sources.env_canada.v3
diff --git a/docs/_sources/api/adios_db.data_sources.env_canada.v1.rst.txt b/docs/_sources/api/adios_db.data_sources.env_canada.v1.rst.txt
@@ -0,0 +1,34 @@
+adios\_db.data\_sources.env\_canada.v1 package
+==============================================
+
+.. automodule:: adios_db.data_sources.env_canada.v1
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+adios\_db.data\_sources.env\_canada.v1.mapper module
+----------------------------------------------------
+
+.. automodule:: adios_db.data_sources.env_canada.v1.mapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.env\_canada.v1.parser module
+----------------------------------------------------
+
+.. automodule:: adios_db.data_sources.env_canada.v1.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.env\_canada.v1.reader module
+----------------------------------------------------
+
+.. automodule:: adios_db.data_sources.env_canada.v1.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/api/adios_db.data_sources.env_canada.v2.rst.txt b/docs/_sources/api/adios_db.data_sources.env_canada.v2.rst.txt
@@ -0,0 +1,34 @@
+adios\_db.data\_sources.env\_canada.v2 package
+==============================================
+
+.. automodule:: adios_db.data_sources.env_canada.v2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+adios\_db.data\_sources.env\_canada.v2.mapper module
+----------------------------------------------------
+
+.. automodule:: adios_db.data_sources.env_canada.v2.mapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.env\_canada.v2.parser module
+----------------------------------------------------
+
+.. automodule:: adios_db.data_sources.env_canada.v2.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.env\_canada.v2.reader module
+----------------------------------------------------
+
+.. automodule:: adios_db.data_sources.env_canada.v2.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/api/adios_db.data_sources.env_canada.v3.rst.txt b/docs/_sources/api/adios_db.data_sources.env_canada.v3.rst.txt
@@ -0,0 +1,42 @@
+adios\_db.data\_sources.env\_canada.v3 package
+==============================================
+
+.. automodule:: adios_db.data_sources.env_canada.v3
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+adios\_db.data\_sources.env\_canada.v3.mapper module
+----------------------------------------------------
+
+.. automodule:: adios_db.data_sources.env_canada.v3.mapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.env\_canada.v3.parser module
+----------------------------------------------------
+
+.. automodule:: adios_db.data_sources.env_canada.v3.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.env\_canada.v3.reader module
+----------------------------------------------------
+
+.. automodule:: adios_db.data_sources.env_canada.v3.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.env\_canada.v3.refcode\_lu module
+---------------------------------------------------------
+
+.. automodule:: adios_db.data_sources.env_canada.v3.refcode_lu
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/api/adios_db.data_sources.exxon_assays.rst.txt b/docs/_sources/api/adios_db.data_sources.exxon_assays.rst.txt
@@ -0,0 +1,51 @@
+adios\_db.data\_sources.exxon\_assays package
+=============================================
+
+.. automodule:: adios_db.data_sources.exxon_assays
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   adios_db.data_sources.exxon_assays.v1
+   adios_db.data_sources.exxon_assays.v2
+
+Submodules
+----------
+
+adios\_db.data\_sources.exxon\_assays.common module
+---------------------------------------------------
+
+.. automodule:: adios_db.data_sources.exxon_assays.common
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.exxon\_assays.mapper module
+---------------------------------------------------
+
+.. automodule:: adios_db.data_sources.exxon_assays.mapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.exxon\_assays.parser module
+---------------------------------------------------
+
+.. automodule:: adios_db.data_sources.exxon_assays.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.exxon\_assays.reader module
+---------------------------------------------------
+
+.. automodule:: adios_db.data_sources.exxon_assays.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/api/adios_db.data_sources.exxon_assays.v1.rst.txt b/docs/_sources/api/adios_db.data_sources.exxon_assays.v1.rst.txt
@@ -0,0 +1,18 @@
+adios\_db.data\_sources.exxon\_assays.v1 package
+================================================
+
+.. automodule:: adios_db.data_sources.exxon_assays.v1
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+adios\_db.data\_sources.exxon\_assays.v1.mapper module
+------------------------------------------------------
+
+.. automodule:: adios_db.data_sources.exxon_assays.v1.mapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/api/adios_db.data_sources.exxon_assays.v2.rst.txt b/docs/_sources/api/adios_db.data_sources.exxon_assays.v2.rst.txt
@@ -0,0 +1,18 @@
+adios\_db.data\_sources.exxon\_assays.v2 package
+================================================
+
+.. automodule:: adios_db.data_sources.exxon_assays.v2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+adios\_db.data\_sources.exxon\_assays.v2.mapper module
+------------------------------------------------------
+
+.. automodule:: adios_db.data_sources.exxon_assays.v2.mapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/api/adios_db.data_sources.noaa_fm.rst.txt b/docs/_sources/api/adios_db.data_sources.noaa_fm.rst.txt
@@ -0,0 +1,42 @@
+adios\_db.data\_sources.noaa\_fm package
+========================================
+
+.. automodule:: adios_db.data_sources.noaa_fm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+adios\_db.data\_sources.noaa\_fm.mapper module
+----------------------------------------------
+
+.. automodule:: adios_db.data_sources.noaa_fm.mapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.noaa\_fm.parser module
+----------------------------------------------
+
+.. automodule:: adios_db.data_sources.noaa_fm.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.noaa\_fm.reader module
+----------------------------------------------
+
+.. automodule:: adios_db.data_sources.noaa_fm.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.noaa\_fm.scoring module
+-----------------------------------------------
+
+.. automodule:: adios_db.data_sources.noaa_fm.scoring
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/api/adios_db.data_sources.rst.txt b/docs/_sources/api/adios_db.data_sources.rst.txt
@@ -0,0 +1,52 @@
+adios\_db.data\_sources package
+===============================
+
+.. automodule:: adios_db.data_sources
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   adios_db.data_sources.env_canada
+   adios_db.data_sources.exxon_assays
+   adios_db.data_sources.noaa_fm
+
+Submodules
+----------
+
+adios\_db.data\_sources.importer\_base module
+---------------------------------------------
+
+.. automodule:: adios_db.data_sources.importer_base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.mapper module
+-------------------------------------
+
+.. automodule:: adios_db.data_sources.mapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.parser module
+-------------------------------------
+
+.. automodule:: adios_db.data_sources.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+adios\_db.data\_sources.reader module
+-------------------------------------
+
+.. automodule:: adios_db.data_sources.reader
+   :members:
+   :undoc-members:
+   :show-inheritance: