Skip to content

Commit

Permalink
updated examples
Browse files Browse the repository at this point in the history
  • Loading branch information
@norlandrhagen
norlandrhagen committed Jul 15, 2020
1 parent 9796317 commit 5044340
Show file tree
Hide file tree
Showing 10 changed files with 17 additions and 35 deletions.
Binary file modified _build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified _build/doctrees/faq_and_contributing/datasubmission.doctree
View file
Binary file not shown.
Binary file modified _build/doctrees/faq_and_contributing/file_structure.doctree
View file
Binary file not shown.
11 changes: 2 additions & 9 deletions _build/html/_sources/faq_and_contributing/datasubmission.rst.txt
View file
Expand Up @@ -8,14 +8,9 @@
..
.. _Download Data Template: https://github.com/simonscmap/DBIngest/raw/master/template/datasetTemplate.xlsx

.. _Download SeaFlow Example: https://github.com/simonscmap/DBIngest/raw/master/template/SeaFlow_2020_06_25_example.xlsx

.. _Download Gradients 1 Fluormetric Chl Example: https://github.com/simonscmap/DBIngest/raw/master/template/Gradients1-KOK1606-FluorometricChlorophyll_2020_06_25_example.xlsx

.. _Download Gradients 1 Cobalamin Example: https://github.com/simonscmap/DBIngest/raw/master/template/KOK1606_Gradients1_Cobalamin_example_2020_07_15.xlsx

.. _Download Gradients 3 Underway CTD Example: https://github.com/simonscmap/DBIngest/raw/master/template/KM1906_Gradients3_uwayCTD_example.xlsx

.. _Download AMT01 Extracted Chlorophyll Example: https://github.com/simonscmap/DBIngest/raw/master/template/amt01_extracted_cholorphyll_2020_07_25.xlsx



Expand Down Expand Up @@ -55,10 +50,8 @@ Dataset Examples



* `Download SeaFlow Example`_
* `Download Gradients 1 Fluormetric Chl Example`_
* `Download Gradients 1 Cobalamin Example`_
* `Download Gradients 3 Underway CTD Example`_
* `Download AMT01 Extracted Chlorophyll Example`_

..
..
Expand Down
8 changes: 4 additions & 4 deletions _build/html/_sources/faq_and_contributing/file_structure.md.txt
View file
Expand Up @@ -54,10 +54,10 @@ This document describes the specifications of the data and metadata fields requ

The CMAP data template consists of three sheets: data, dataset metadata, and variable metadata. Data is stored in the first sheet called “data”. Metadata that describes the dataset is entered in the second sheet called “dataset_meta_data”. Metadata associated with the variables in the dataset are entered in the third sheet called “vars_meta_data”. Information must be provided for all columns except those specifcally noted as optional. For those datasets that use the Excel template, a web-based tool is available through <a href="https://simonscmap.com/datasubmission">Simons CMAP</a> to validate and modify a given dataset to ensure it conforms to structure requirements for dataset submission. Below are a few example datasets that have been prepared using the specifications described in this document:

* [SeaFlow](https://github.com/simonscmap/DBIngest/raw/master/template/SeaFlow_2020_06_25_example.xlsx)
* [Gradients 1 Fluormetric Chl](https://github.com/simonscmap/DBIngest/raw/master/template/Gradients1-KOK1606-FluorometricChlorophyll_2020_06_25_example.xlsx)
* [Gradients 1 Cobalamin](https://github.com/simonscmap/DBIngest/raw/master/template/KOK1606_Gradients1_Cobalamin_example_2020_06_26.xlsx)
* [Gradients 3 Underway CTD](https://github.com/simonscmap/DBIngest/raw/master/template/KM1906_Gradients3_uwayCTD_example.xlsx)
* [Gradients 1 Cobalamin](https://github.com/simonscmap/DBIngest/raw/master/template/KOK1606_Gradients1_Cobalamin_example_2020_07_15.xlsx)

* [AMT01 Extracted Chlorophyll](https://github.com/simonscmap/DBIngest/raw/master/template/amt01_extracted_cholorphyll_2020_07_25.xls)

------------------------------------------

<br/><br/>
Expand Down
4 changes: 1 addition & 3 deletions _build/html/faq_and_contributing/datasubmission.html
View file
Expand Up @@ -246,10 +246,8 @@ <h2>Data Template<a class="headerlink" href="#data-template" title="Permalink to
<div class="section" id="dataset-examples">
<h2>Dataset Examples<a class="headerlink" href="#dataset-examples" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/simonscmap/DBIngest/raw/master/template/SeaFlow_2020_06_25_example.xlsx">Download SeaFlow Example</a></p></li>
<li><p><a class="reference external" href="https://github.com/simonscmap/DBIngest/raw/master/template/Gradients1-KOK1606-FluorometricChlorophyll_2020_06_25_example.xlsx">Download Gradients 1 Fluormetric Chl Example</a></p></li>
<li><p><a class="reference external" href="https://github.com/simonscmap/DBIngest/raw/master/template/KOK1606_Gradients1_Cobalamin_example_2020_07_15.xlsx">Download Gradients 1 Cobalamin Example</a></p></li>
<li><p><a class="reference external" href="https://github.com/simonscmap/DBIngest/raw/master/template/KM1906_Gradients3_uwayCTD_example.xlsx">Download Gradients 3 Underway CTD Example</a></p></li>
<li><p><a class="reference external" href="https://github.com/simonscmap/DBIngest/raw/master/template/amt01_extracted_cholorphyll_2020_07_25.xlsx">Download AMT01 Extracted Chlorophyll Example</a></p></li>
</ul>
</div>
</div>
Expand Down
8 changes: 3 additions & 5 deletions _build/html/faq_and_contributing/file_structure.html
View file
Expand Up @@ -288,10 +288,8 @@ <h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to t
<div style="text-align: right"><a href="#toc" title="Table of Contents">Table of Contents</a></div>
This document describes the specifications of the data and metadata fields required for submitting datasets to the Simons CMAP database. The submitted data can be in any file format such as netCDF, parquet, plain text, CSV, or Excel files. The only requirement is that information for all required fields (specified by <sup>*</sup> ) is provided. For simplicity, we have created an empty dataset template in Excel format that can be found <a href="https://github.com/simonscmap/DBIngest/raw/master/template/datasetTemplate.xlsx">here</a>. You can use this template to load and submit your dataset. The data and metadata field names (e.g. time, lat, lon, short_name, long_name, ...) used in the template file are based on the CF and COARDS naming conventions [<a href="#ref1">1</a>, <a href="#ref1">2</a>, <a href="#ref1">3</a>].<p>The CMAP data template consists of three sheets: data, dataset metadata, and variable metadata. Data is stored in the first sheet called “data”. Metadata that describes the dataset is entered in the second sheet called “dataset_meta_data”. Metadata associated with the variables in the dataset are entered in the third sheet called “vars_meta_data”. Information must be provided for all columns except those specifcally noted as optional. For those datasets that use the Excel template, a web-based tool is available through <a href="https://simonscmap.com/datasubmission">Simons CMAP</a> to validate and modify a given dataset to ensure it conforms to structure requirements for dataset submission. Below are a few example datasets that have been prepared using the specifications described in this document:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/simonscmap/DBIngest/raw/master/template/SeaFlow_2020_06_25_example.xlsx">SeaFlow</a></p></li>
<li><p><a class="reference external" href="https://github.com/simonscmap/DBIngest/raw/master/template/Gradients1-KOK1606-FluorometricChlorophyll_2020_06_25_example.xlsx">Gradients 1 Fluormetric Chl</a></p></li>
<li><p><a class="reference external" href="https://github.com/simonscmap/DBIngest/raw/master/template/KOK1606_Gradients1_Cobalamin_example_2020_06_26.xlsx">Gradients 1 Cobalamin</a></p></li>
<li><p><a class="reference external" href="https://github.com/simonscmap/DBIngest/raw/master/template/KM1906_Gradients3_uwayCTD_example.xlsx">Gradients 3 Underway CTD</a></p></li>
<li><p><a class="reference external" href="https://github.com/simonscmap/DBIngest/raw/master/template/KOK1606_Gradients1_Cobalamin_example_2020_07_15.xlsx">Gradients 1 Cobalamin</a></p></li>
<li><p><a class="reference external" href="https://github.com/simonscmap/DBIngest/raw/master/template/amt01_extracted_cholorphyll_2020_07_25.xls">AMT01 Extracted Chlorophyll</a></p></li>
</ul>
<hr class="docutils" />
<p><br/><br/>
Expand Down Expand Up @@ -728,7 +726,7 @@ <h3>References<a class="headerlink" href="#references" title="Permalink to this

&copy; Copyright
<span class="lastupdated">
Last updated on Jul 06, 2020.
Last updated on Jul 15, 2020.
</span>

</p>
Expand Down
2 changes: 1 addition & 1 deletion _build/html/searchindex.js
View file

Large diffs are not rendered by default.

11 changes: 2 additions & 9 deletions faq_and_contributing/datasubmission.rst
View file
Expand Up @@ -8,14 +8,9 @@
..
.. _Download Data Template: https://github.com/simonscmap/DBIngest/raw/master/template/datasetTemplate.xlsx

.. _Download SeaFlow Example: https://github.com/simonscmap/DBIngest/raw/master/template/SeaFlow_2020_06_25_example.xlsx

.. _Download Gradients 1 Fluormetric Chl Example: https://github.com/simonscmap/DBIngest/raw/master/template/Gradients1-KOK1606-FluorometricChlorophyll_2020_06_25_example.xlsx

.. _Download Gradients 1 Cobalamin Example: https://github.com/simonscmap/DBIngest/raw/master/template/KOK1606_Gradients1_Cobalamin_example_2020_07_15.xlsx

.. _Download Gradients 3 Underway CTD Example: https://github.com/simonscmap/DBIngest/raw/master/template/KM1906_Gradients3_uwayCTD_example.xlsx

.. _Download AMT01 Extracted Chlorophyll Example: https://github.com/simonscmap/DBIngest/raw/master/template/amt01_extracted_cholorphyll_2020_07_25.xlsx



Expand Down Expand Up @@ -55,10 +50,8 @@ Dataset Examples



* `Download SeaFlow Example`_
* `Download Gradients 1 Fluormetric Chl Example`_
* `Download Gradients 1 Cobalamin Example`_
* `Download Gradients 3 Underway CTD Example`_
* `Download AMT01 Extracted Chlorophyll Example`_

..
..
Expand Down
8 changes: 4 additions & 4 deletions faq_and_contributing/file_structure.md
View file
Expand Up @@ -54,10 +54,10 @@ This document describes the specifications of the data and metadata fields requ

The CMAP data template consists of three sheets: data, dataset metadata, and variable metadata. Data is stored in the first sheet called “data”. Metadata that describes the dataset is entered in the second sheet called “dataset_meta_data”. Metadata associated with the variables in the dataset are entered in the third sheet called “vars_meta_data”. Information must be provided for all columns except those specifcally noted as optional. For those datasets that use the Excel template, a web-based tool is available through <a href="https://simonscmap.com/datasubmission">Simons CMAP</a> to validate and modify a given dataset to ensure it conforms to structure requirements for dataset submission. Below are a few example datasets that have been prepared using the specifications described in this document:

* [SeaFlow](https://github.com/simonscmap/DBIngest/raw/master/template/SeaFlow_2020_06_25_example.xlsx)
* [Gradients 1 Fluormetric Chl](https://github.com/simonscmap/DBIngest/raw/master/template/Gradients1-KOK1606-FluorometricChlorophyll_2020_06_25_example.xlsx)
* [Gradients 1 Cobalamin](https://github.com/simonscmap/DBIngest/raw/master/template/KOK1606_Gradients1_Cobalamin_example_2020_06_26.xlsx)
* [Gradients 3 Underway CTD](https://github.com/simonscmap/DBIngest/raw/master/template/KM1906_Gradients3_uwayCTD_example.xlsx)
* [Gradients 1 Cobalamin](https://github.com/simonscmap/DBIngest/raw/master/template/KOK1606_Gradients1_Cobalamin_example_2020_07_15.xlsx)

* [AMT01 Extracted Chlorophyll](https://github.com/simonscmap/DBIngest/raw/master/template/amt01_extracted_cholorphyll_2020_07_25.xls)

------------------------------------------

<br/><br/>
Expand Down

0 comments on commit 5044340

Please sign in to comment.