diff --git a/docs/_html/.doctrees/api.doctree b/docs/_html/.doctrees/api.doctree index 3fe6bb1..2cb3287 100644 Binary files a/docs/_html/.doctrees/api.doctree and b/docs/_html/.doctrees/api.doctree differ diff --git a/docs/_html/.doctrees/environment.pickle b/docs/_html/.doctrees/environment.pickle index b6329e1..79fb8df 100644 Binary files a/docs/_html/.doctrees/environment.pickle and b/docs/_html/.doctrees/environment.pickle differ diff --git a/docs/_html/.doctrees/generated/neonutilities.by_file_aop.doctree b/docs/_html/.doctrees/generated/neonutilities.by_file_aop.doctree new file mode 100644 index 0000000..6fc9cfe Binary files /dev/null and b/docs/_html/.doctrees/generated/neonutilities.by_file_aop.doctree differ diff --git a/docs/_html/.doctrees/generated/neonutilities.by_tile_aop.doctree b/docs/_html/.doctrees/generated/neonutilities.by_tile_aop.doctree new file mode 100644 index 0000000..5b90ed7 Binary files /dev/null and b/docs/_html/.doctrees/generated/neonutilities.by_tile_aop.doctree differ diff --git a/docs/_html/.doctrees/generated/neonutilities.get_citation.doctree b/docs/_html/.doctrees/generated/neonutilities.get_citation.doctree new file mode 100644 index 0000000..8cf77f9 Binary files /dev/null and b/docs/_html/.doctrees/generated/neonutilities.get_citation.doctree differ diff --git a/docs/_html/.doctrees/generated/neonutilities.get_issue_log.doctree b/docs/_html/.doctrees/generated/neonutilities.get_issue_log.doctree new file mode 100644 index 0000000..56cb825 Binary files /dev/null and b/docs/_html/.doctrees/generated/neonutilities.get_issue_log.doctree differ diff --git a/docs/_html/.doctrees/generated/neonutilities.load_by_product.doctree b/docs/_html/.doctrees/generated/neonutilities.load_by_product.doctree new file mode 100644 index 0000000..b5362a9 Binary files /dev/null and b/docs/_html/.doctrees/generated/neonutilities.load_by_product.doctree differ diff --git a/docs/_html/.doctrees/generated/neonutilities.read_table_neon.doctree b/docs/_html/.doctrees/generated/neonutilities.read_table_neon.doctree new file mode 100644 index 0000000..14b043c Binary files /dev/null and b/docs/_html/.doctrees/generated/neonutilities.read_table_neon.doctree differ diff --git a/docs/_html/.doctrees/generated/neonutilities.stack_by_table.doctree b/docs/_html/.doctrees/generated/neonutilities.stack_by_table.doctree new file mode 100644 index 0000000..5070865 Binary files /dev/null and b/docs/_html/.doctrees/generated/neonutilities.stack_by_table.doctree differ diff --git a/docs/_html/.doctrees/generated/neonutilities.zips_by_product.doctree b/docs/_html/.doctrees/generated/neonutilities.zips_by_product.doctree new file mode 100644 index 0000000..ebe8eb1 Binary files /dev/null and b/docs/_html/.doctrees/generated/neonutilities.zips_by_product.doctree differ diff --git a/docs/_html/_sources/api.rst.txt b/docs/_html/_sources/api.rst.txt index c6a88c2..2898030 100644 --- a/docs/_html/_sources/api.rst.txt +++ b/docs/_html/_sources/api.rst.txt @@ -4,5 +4,11 @@ API .. autosummary:: :toctree: generated - neonutilities.aop_download.by_file_aop - neonutilities.aop_download.by_tile_aop + neonutilities.by_file_aop + neonutilities.by_tile_aop + neonutilities.load_by_product + neonutilities.zips_by_product + neonutilities.stack_by_table + neonutilities.read_table_neon + neonutilities.get_citation + neonutilities.get_issue_log diff --git a/docs/_html/_sources/generated/neonutilities.aop_download.by_file_aop.rst.txt b/docs/_html/_sources/generated/neonutilities.aop_download.by_file_aop.rst.txt deleted file mode 100644 index ee0e047..0000000 --- a/docs/_html/_sources/generated/neonutilities.aop_download.by_file_aop.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -neonutilities.aop\_download.by\_file\_aop -========================================= - -.. currentmodule:: neonutilities.aop_download - -.. autofunction:: by_file_aop \ No newline at end of file diff --git a/docs/_html/_sources/generated/neonutilities.aop_download.by_tile_aop.rst.txt b/docs/_html/_sources/generated/neonutilities.aop_download.by_tile_aop.rst.txt deleted file mode 100644 index d4016f9..0000000 --- a/docs/_html/_sources/generated/neonutilities.aop_download.by_tile_aop.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -neonutilities.aop\_download.by\_tile\_aop -========================================= - -.. currentmodule:: neonutilities.aop_download - -.. autofunction:: by_tile_aop \ No newline at end of file diff --git a/docs/_html/_sources/generated/neonutilities.by_file_aop.rst.txt b/docs/_html/_sources/generated/neonutilities.by_file_aop.rst.txt new file mode 100644 index 0000000..db54c16 --- /dev/null +++ b/docs/_html/_sources/generated/neonutilities.by_file_aop.rst.txt @@ -0,0 +1,6 @@ +neonutilities.by\_file\_aop +=========================== + +.. currentmodule:: neonutilities + +.. autofunction:: by_file_aop \ No newline at end of file diff --git a/docs/_html/_sources/generated/neonutilities.by_tile_aop.rst.txt b/docs/_html/_sources/generated/neonutilities.by_tile_aop.rst.txt new file mode 100644 index 0000000..4d5dff7 --- /dev/null +++ b/docs/_html/_sources/generated/neonutilities.by_tile_aop.rst.txt @@ -0,0 +1,6 @@ +neonutilities.by\_tile\_aop +=========================== + +.. currentmodule:: neonutilities + +.. autofunction:: by_tile_aop \ No newline at end of file diff --git a/docs/_html/_sources/generated/neonutilities.get_citation.rst.txt b/docs/_html/_sources/generated/neonutilities.get_citation.rst.txt new file mode 100644 index 0000000..8bd9b09 --- /dev/null +++ b/docs/_html/_sources/generated/neonutilities.get_citation.rst.txt @@ -0,0 +1,6 @@ +neonutilities.get\_citation +=========================== + +.. currentmodule:: neonutilities + +.. autofunction:: get_citation \ No newline at end of file diff --git a/docs/_html/_sources/generated/neonutilities.get_issue_log.rst.txt b/docs/_html/_sources/generated/neonutilities.get_issue_log.rst.txt new file mode 100644 index 0000000..6e2fe1b --- /dev/null +++ b/docs/_html/_sources/generated/neonutilities.get_issue_log.rst.txt @@ -0,0 +1,6 @@ +neonutilities.get\_issue\_log +============================= + +.. currentmodule:: neonutilities + +.. autofunction:: get_issue_log \ No newline at end of file diff --git a/docs/_html/_sources/generated/neonutilities.load_by_product.rst.txt b/docs/_html/_sources/generated/neonutilities.load_by_product.rst.txt new file mode 100644 index 0000000..055831f --- /dev/null +++ b/docs/_html/_sources/generated/neonutilities.load_by_product.rst.txt @@ -0,0 +1,6 @@ +neonutilities.load\_by\_product +=============================== + +.. currentmodule:: neonutilities + +.. autofunction:: load_by_product \ No newline at end of file diff --git a/docs/_html/_sources/generated/neonutilities.read_table_neon.rst.txt b/docs/_html/_sources/generated/neonutilities.read_table_neon.rst.txt new file mode 100644 index 0000000..bce1874 --- /dev/null +++ b/docs/_html/_sources/generated/neonutilities.read_table_neon.rst.txt @@ -0,0 +1,6 @@ +neonutilities.read\_table\_neon +=============================== + +.. currentmodule:: neonutilities + +.. autofunction:: read_table_neon \ No newline at end of file diff --git a/docs/_html/_sources/generated/neonutilities.stack_by_table.rst.txt b/docs/_html/_sources/generated/neonutilities.stack_by_table.rst.txt new file mode 100644 index 0000000..2d565ec --- /dev/null +++ b/docs/_html/_sources/generated/neonutilities.stack_by_table.rst.txt @@ -0,0 +1,6 @@ +neonutilities.stack\_by\_table +============================== + +.. currentmodule:: neonutilities + +.. autofunction:: stack_by_table \ No newline at end of file diff --git a/docs/_html/_sources/generated/neonutilities.zips_by_product.rst.txt b/docs/_html/_sources/generated/neonutilities.zips_by_product.rst.txt new file mode 100644 index 0000000..25ae2c5 --- /dev/null +++ b/docs/_html/_sources/generated/neonutilities.zips_by_product.rst.txt @@ -0,0 +1,6 @@ +neonutilities.zips\_by\_product +=============================== + +.. currentmodule:: neonutilities + +.. autofunction:: zips_by_product \ No newline at end of file diff --git a/docs/_html/api.html b/docs/_html/api.html index 135745a..6ed2b70 100644 --- a/docs/_html/api.html +++ b/docs/_html/api.html @@ -14,7 +14,7 @@ - + @@ -37,12 +37,30 @@

API

- + - + + + + + + + + + + + + + + + + + + +

neonutilities.aop_download.by_file_aop(dpid, ...)

neonutilities.by_file_aop(dpid, site, year)

This function queries the API for AOP data by site, year, and product, and downloads all files found, preserving the original folder structure.

neonutilities.aop_download.by_tile_aop(dpid, ...)

neonutilities.by_tile_aop(dpid, site, year, ...)

This function queries the API for AOP data by site, year, product, and UTM coordinates, and downloads all files found, preserving the original folder structure.

neonutilities.load_by_product(dpid[, site, ...])

Download product-site-month data package files from NEON, stack, and load to the environment.

neonutilities.zips_by_product(dpid[, site, ...])

Download product-site-month data package files from NEON.

neonutilities.stack_by_table(filepath[, ...])

Join data files in a zipped or unzipped NEON data package by table type.

neonutilities.read_table_neon(data_file, ...)

Read a NEON data table with correct data types for each variable.

neonutilities.get_citation(dpid, release)

Use the DOI Foundation API to get BibTex-formatted citations for NEON data, or use a template to generate a BibTex citation for provisional data.

neonutilities.get_issue_log(dpid[, token])

Retrieves the issue log for any NEON data products.
@@ -78,8 +96,14 @@

neonutilities

  • Get started with neonutilities
  • Tutorials
  • API
    • @@ -89,7 +113,7 @@

    Related Topics

    diff --git a/docs/_html/generated/neonutilities.aop_download.by_file_aop.html b/docs/_html/generated/neonutilities.by_file_aop.html similarity index 73% rename from docs/_html/generated/neonutilities.aop_download.by_file_aop.html rename to docs/_html/generated/neonutilities.by_file_aop.html index e6f91fc..b3a5a27 100644 --- a/docs/_html/generated/neonutilities.aop_download.by_file_aop.html +++ b/docs/_html/generated/neonutilities.by_file_aop.html @@ -5,7 +5,7 @@ - neonutilities.aop_download.by_file_aop — neonutilities 1.0.1 documentation + neonutilities.by_file_aop — neonutilities 1.0.1 documentation @@ -14,7 +14,7 @@ - + @@ -33,11 +33,11 @@
    -
    -

    neonutilities.aop_download.by_file_aop

    +
    +

    neonutilities.by_file_aop

    -
    -neonutilities.aop_download.by_file_aop(dpid, site, year, include_provisional=False, check_size=True, savepath=None, chunk_size=1024, token=None)
    +
    +neonutilities.by_file_aop(dpid, site, year, include_provisional=False, check_size=True, savepath=None, chunk_size=1024, token=None)

    This function queries the API for AOP data by site, year, and product, and downloads all files found, preserving the original folder structure. It downloads files serially to avoid API rate-limit overload, which may take a long time.

    @@ -124,8 +124,8 @@

    neonutilities

  • Get started with neonutilities
  • Tutorials
  • API
    • @@ -136,7 +136,7 @@

    Related Topics

  • Documentation overview
    • @@ -161,7 +161,7 @@

    Related Topics

    & Alabaster 1.0.0 | - Page source
    diff --git a/docs/_html/generated/neonutilities.aop_download.by_tile_aop.html b/docs/_html/generated/neonutilities.by_tile_aop.html similarity index 69% rename from docs/_html/generated/neonutilities.aop_download.by_tile_aop.html rename to docs/_html/generated/neonutilities.by_tile_aop.html index 00e96e8..d88467e 100644 --- a/docs/_html/generated/neonutilities.aop_download.by_tile_aop.html +++ b/docs/_html/generated/neonutilities.by_tile_aop.html @@ -5,7 +5,7 @@ - neonutilities.aop_download.by_tile_aop — neonutilities 1.0.1 documentation + neonutilities.by_tile_aop — neonutilities 1.0.1 documentation @@ -14,7 +14,7 @@ - + @@ -32,11 +32,11 @@
    -
    -

    neonutilities.aop_download.by_tile_aop

    +
    +

    neonutilities.by_tile_aop

    -
    -neonutilities.aop_download.by_tile_aop(dpid, site, year, easting, northing, buffer=0, include_provisional=False, check_size=True, savepath=None, chunk_size=1024, token=None, verbose=False)
    +
    +neonutilities.by_tile_aop(dpid, site, year, easting, northing, buffer=0, include_provisional=False, check_size=True, savepath=None, chunk_size=1024, token=None, verbose=False)

    This function queries the API for AOP data by site, year, product, and UTM coordinates, and downloads all files found, preserving the original folder structure. It downloads files serially to avoid API rate-limit @@ -133,8 +133,8 @@

    neonutilities

  • Get started with neonutilities
  • Tutorials
  • API
    • @@ -144,7 +144,7 @@

    Related Topics

    @@ -169,7 +169,7 @@

    Related Topics

    & Alabaster 1.0.0 | - Page source
    diff --git a/docs/_html/generated/neonutilities.get_citation.html b/docs/_html/generated/neonutilities.get_citation.html new file mode 100644 index 0000000..68245ea --- /dev/null +++ b/docs/_html/generated/neonutilities.get_citation.html @@ -0,0 +1,149 @@ + + + + + + + + neonutilities.get_citation — neonutilities 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + + +
    + +
    +

    neonutilities.get_citation

    +
    +
    +neonutilities.get_citation(dpid, release)
    +

    Use the DOI Foundation API to get BibTex-formatted citations for NEON data, +or use a template to generate a BibTex citation for provisional data. +Helper function to download and stacking functions.

    +
    +

    Parameters

    +

    dpid : The data product ID of the data to be cited +release : The data release to be cited. Can be provisional.

    +
    +
    +

    Return

    +

    A character string containing the citation in BibTex format.

    +
    +
    +

    Example

    +

    Get the citation for Breeding landbird point counts (DP1.10003.001), +RELEASE-2023

    +
    >>> cit = get_citation(dpid="DP1.10003.001", release="RELEASE-2023")
+
    +
    +

    Created on Fri Aug 25 10:26:23 2023

    +

    @author: Claire Lunch

    +
    +
    + +
    + + +
    + +
    +
    + +
    +
    +
    + ©2024, Claire Lunch. + + | + Powered by Sphinx 8.1.3 + & Alabaster 1.0.0 + + | + Page source +
    + + + + + + \ No newline at end of file diff --git a/docs/_html/generated/neonutilities.get_issue_log.html b/docs/_html/generated/neonutilities.get_issue_log.html new file mode 100644 index 0000000..fb7fdba --- /dev/null +++ b/docs/_html/generated/neonutilities.get_issue_log.html @@ -0,0 +1,144 @@ + + + + + + + + neonutilities.get_issue_log — neonutilities 1.0.1 documentation + + + + + + + + + + + + + + + + + + + +
    +
    +
    + + +
    + +
    +

    neonutilities.get_issue_log

    +
    +
    +neonutilities.get_issue_log(dpid, token=None)
    +

    Retrieves the issue log for any NEON data products. Bundled eddy covariance data products have an additional column of the sub-data product id.

    +
    +
    Args:

    dpid (str): The NEON data product ID. +token (str, optional): The NEON API token. Defaults to None.

    +
    +
    Returns:

    issue_log_df: A DataFrame containing the changeLogs for the provided dpid. +columns of the bundled eddy data frame are: ‘dpid’, ‘id’, +‘parentIssueID’, ‘issueDate’, ‘resolvedDate’, ‘dateRangeStart’, +‘dateRangeEnd’, ‘locationAffected’, ‘issue’, ‘resolution’; +all other data products have the same columns minus ‘dpid’

    +
    +
    +
    +

    Example

    +

    Get the issue log for Breeding landbird point counts (DP1.10003.001)

    +
    >>> birdiss = get_issue_log(dpid="DP1.10003.001")
+
    +
    +
    +
    + +
    + + +
    + +
    +
    + +
    +
    +
    + ©2024, Claire Lunch. + + | + Powered by Sphinx 8.1.3 + & Alabaster 1.0.0 + + | + Page source +
    + + + + + + \ No newline at end of file diff --git a/docs/_html/generated/neonutilities.load_by_product.html b/docs/_html/generated/neonutilities.load_by_product.html new file mode 100644 index 0000000..118c225 --- /dev/null +++ b/docs/_html/generated/neonutilities.load_by_product.html @@ -0,0 +1,159 @@ + + + + + + + + neonutilities.load_by_product — neonutilities 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + + +
    + +
    +

    neonutilities.load_by_product

    +
    +
    +neonutilities.load_by_product(dpid, site='all', startdate=None, enddate=None, package='basic', release='current', timeindex='all', tabl='all', check_size=True, include_provisional=False, cloud_mode=False, progress=True, token=None)
    +

    Download product-site-month data package files from NEON, stack, and load to the environment.

    +
    +

    Parameters

    +

    dpid: Data product identifier in the form DP#.#####.### +site: Either the string ‘all’, or one or more 4-letter NEON site codes +startdate: Earliest date of data to download, in the form YYYY-MM +enddate: Latest date of data to download, in the form YYYY-MM +package: Download package to access, either basic or expanded +release: Data release to download. Defaults to the most recent release. +timeindex: Either the string ‘all’, or the time index of data to download, in minutes. Only applicable to sensor (IS) data. Defaults to ‘all’. +tabl: Either the string ‘all’, or the name of a single data table to download. Defaults to ‘all’. +check_size: True or False, should the user approve the total file size before downloading? Defaults to True. When working in batch mode, or other non-interactive workflow, use check_size=False. +include_provisional: Should Provisional data be returned in the download? Defaults to False. +cloud_mode: Use cloud mode to transfer files cloud-to-cloud? Should only be used if the destination location is in the cloud. Defaults to False. +progress: Should the function display progress bars as it runs? Defaults to True +token: User specific API token (generated within neon.datascience user accounts). If omitted, download uses the public rate limit.

    +
    +
    +

    Return

    +

    A folder on the local drive containing the set of data package files meeting the input criteria.

    +
    +
    +

    Example

    +

    Download water quality data from COMO (Como Creek) in 2018

    +
    >>> wq = load_by_product(dpid="DP1.20288.001",site="COMO",
+                         startdate="2018-01", enddate="2018-12",
+                         token=None)
+
    +
    +

    Created on June 12 2024

    +

    @author: Claire Lunch

    +
    +
    + +
    + + +
    + +
    +
    + +
    +
    +
    + ©2024, Claire Lunch. + + | + Powered by Sphinx 8.1.3 + & Alabaster 1.0.0 + + | + Page source +
    + + + + + + \ No newline at end of file diff --git a/docs/_html/generated/neonutilities.read_table_neon.html b/docs/_html/generated/neonutilities.read_table_neon.html new file mode 100644 index 0000000..cd4693f --- /dev/null +++ b/docs/_html/generated/neonutilities.read_table_neon.html @@ -0,0 +1,146 @@ + + + + + + + + neonutilities.read_table_neon — neonutilities 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + + +
    + +
    +

    neonutilities.read_table_neon

    +
    +
    +neonutilities.read_table_neon(data_file, var_file)
    +

    Read a NEON data table with correct data types for each variable.

    +
    +

    Parameters

    +

    data_file: Filepath to a data table to load. +var_file: Filepath to the variables file.

    +
    +
    +

    Return

    +

    A data frame of a NEON data table, with column classes assigned by data type.

    +
    +
    +

    Example

    +
    >>> dattab = read_table_neon(data_file="path to data table file",
+                             var_file="path to variables file matching data table")
+
    +
    +

    Created on Thu Feb 1 2024

    +

    @author: Zachary Nickerson

    +
    +
    + +
    + + +
    + +
    +
    + +
    +
    +
    + ©2024, Claire Lunch. + + | + Powered by Sphinx 8.1.3 + & Alabaster 1.0.0 + + | + Page source +
    + + + + + + \ No newline at end of file diff --git a/docs/_html/generated/neonutilities.stack_by_table.html b/docs/_html/generated/neonutilities.stack_by_table.html new file mode 100644 index 0000000..510ed7a --- /dev/null +++ b/docs/_html/generated/neonutilities.stack_by_table.html @@ -0,0 +1,147 @@ + + + + + + + + neonutilities.stack_by_table — neonutilities 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + + +
    + +
    +

    neonutilities.stack_by_table

    +
    +
    +neonutilities.stack_by_table(filepath, savepath=None, save_unzipped_files=False, progress=True, cloud_mode=False)
    +

    Join data files in a zipped or unzipped NEON data package by table type.

    +
    +

    Parameters

    +

    filepath: The location of the zip file or downloaded files. +savepath: The location to save the output files to. (optional) +save_unzipped_files: Should the unzipped monthly data folders be retained? (true/false) +progress: Should a progress bar be displayed? +cloud_mode: Use cloud mode to transfer files cloud-to-cloud? If used, stack_by_table() expects a list of file urls as input. Defaults to False.

    +
    +
    +

    Return

    +

    All files are unzipped and one file for each table type is created and written. If savepath=”envt” is specified, output is a named list of tables; otherwise, function output is null and files are saved to the location specified.

    +
    +
    +

    Example

    +

    # To stack PAR data (DP1.00024.001) downloaded from the NEON data portal +>>> pardat = stack_by_table(“/filepath/NEON_par.zip”)

    +

    Created on Tue Mar 5 2024

    +

    @author: Zachary Nickerson

    +
    +
    + +
    + + +
    + +
    +
    + +
    +
    +
    + ©2024, Claire Lunch. + + | + Powered by Sphinx 8.1.3 + & Alabaster 1.0.0 + + | + Page source +
    + + + + + + \ No newline at end of file diff --git a/docs/_html/generated/neonutilities.zips_by_product.html b/docs/_html/generated/neonutilities.zips_by_product.html new file mode 100644 index 0000000..4b8dd55 --- /dev/null +++ b/docs/_html/generated/neonutilities.zips_by_product.html @@ -0,0 +1,160 @@ + + + + + + + + neonutilities.zips_by_product — neonutilities 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + + +
    + +
    +

    neonutilities.zips_by_product

    +
    +
    +neonutilities.zips_by_product(dpid, site='all', startdate=None, enddate=None, package='basic', release='current', timeindex='all', tabl='all', check_size=True, include_provisional=False, cloud_mode=False, progress=True, token=None, savepath=None)
    +

    Download product-site-month data package files from NEON.

    +
    +

    Parameters

    +

    dpid: Data product identifier in the form DP#.#####.### +site: Either the string ‘all’, or one or more 4-letter NEON site codes. Defaults to ‘all’. +startdate: Earliest date of data to download, in the form YYYY-MM +enddate: Latest date of data to download, in the form YYYY-MM +package: Download package to access, either basic or expanded +release: Data release to download. Defaults to the most recent release. +timeindex: Either the string ‘all’, or the time index of data to download, in minutes. Only applicable to sensor (IS) data. Defaults to ‘all’. +tabl: Either the string ‘all’, or the name of a single data table to download. Defaults to ‘all’. +check_size: True or False, should the user approve the total file size before downloading? Defaults to True. When working in batch mode, or other non-interactive workflow, use check_size=False. +include_provisional: Should Provisional data be returned in the download? Defaults to False. +cloud_mode: Use cloud mode to transfer files cloud-to-cloud? If used, zips_by_product() returns a list of files rather than downloading them. Defaults to False. +progress: Should the function display progress bars as it runs? Defaults to True +token: User specific API token (generated within neon.datascience user accounts). If omitted, download uses the public rate limit. +savepath: File path of location to save data.

    +
    +
    +

    Return

    +

    A folder on the local drive containing the set of data package files meeting the input criteria.

    +
    +
    +

    Example

    +

    Download water quality data from COMO (Como Creek) in 2018

    +
    >>> zips_by_product(dpid="DP1.20288.001",site="COMO",
+                    startdate="2018-01", enddate="2018-12",
+                    token=None, savepath="/mypath/Downloads")
+
    +
    +

    Created on Wed Jan 31 14:36:22 2024

    +

    @author: Claire Lunch

    +
    +
    + +
    + + +
    + +
    +
    + +
    +
    +
    + ©2024, Claire Lunch. + + | + Powered by Sphinx 8.1.3 + & Alabaster 1.0.0 + + | + Page source +
    + + + + + + \ No newline at end of file diff --git a/docs/_html/genindex.html b/docs/_html/genindex.html index 4667f16..b1eb769 100644 --- a/docs/_html/genindex.html +++ b/docs/_html/genindex.html @@ -35,16 +35,73 @@

    Index

    B + | G + | L + | R + | S + | Z

    B

    + +
    + +

    G

    + + + +
    + +

    L

    + + +
    + +

    R

    + + +
    + +

    S

    + + +
    + +

    Z

    +
    diff --git a/docs/_html/index.html b/docs/_html/index.html index 2d2f028..c75b929 100644 --- a/docs/_html/index.html +++ b/docs/_html/index.html @@ -46,8 +46,14 @@

    neonutilities documentationTutorials
  • API
    • diff --git a/docs/_html/objects.inv b/docs/_html/objects.inv index 602776b..ba6d830 100644 --- a/docs/_html/objects.inv +++ b/docs/_html/objects.inv @@ -2,5 +2,4 @@ # Project: neonutilities # Version: # The remainder of this file is compressed using zlib. -xڥRj0 +5aX!sdؚf齧dDhɳ65RڡVBJU ֡ ô?{jX[H8JFD7ˎ{ovrXmA(g غD:۸b 8 Ilh b9w̚±C>> dattab = read_table_neon(data_file="path to data table file", var_file="path to variables file matching data table") diff --git a/src/neonutilities/tabular_download.py b/src/neonutilities/tabular_download.py index a076293..bf76ba7 100644 --- a/src/neonutilities/tabular_download.py +++ b/src/neonutilities/tabular_download.py @@ -143,7 +143,7 @@ def zips_by_product(dpid, site="all", startdate=None, enddate=None, Download product-site-month data package files from NEON. Parameters - -------- + ------------------ dpid: Data product identifier in the form DP#.#####.### site: Either the string 'all', or one or more 4-letter NEON site codes. Defaults to 'all'. startdate: Earliest date of data to download, in the form YYYY-MM @@ -160,11 +160,11 @@ def zips_by_product(dpid, site="all", startdate=None, enddate=None, savepath: File path of location to save data. Return - -------- + ----------------- A folder on the local drive containing the set of data package files meeting the input criteria. Example - -------- + ----------------- Download water quality data from COMO (Como Creek) in 2018 >>> zips_by_product(dpid="DP1.20288.001",site="COMO", diff --git a/src/neonutilities/unzip_and_stack.py b/src/neonutilities/unzip_and_stack.py index 625ddd2..bfc76e4 100644 --- a/src/neonutilities/unzip_and_stack.py +++ b/src/neonutilities/unzip_and_stack.py @@ -1023,7 +1023,7 @@ def stack_by_table(filepath, Join data files in a zipped or unzipped NEON data package by table type. Parameters - -------- + ------------------ filepath: The location of the zip file or downloaded files. savepath: The location to save the output files to. (optional) save_unzipped_files: Should the unzipped monthly data folders be retained? (true/false) @@ -1031,11 +1031,11 @@ def stack_by_table(filepath, cloud_mode: Use cloud mode to transfer files cloud-to-cloud? If used, stack_by_table() expects a list of file urls as input. Defaults to False. Return - -------- + ------------------- All files are unzipped and one file for each table type is created and written. If savepath="envt" is specified, output is a named list of tables; otherwise, function output is null and files are saved to the location specified. Example - -------- + ------------------ # To stack PAR data (DP1.00024.001) downloaded from the NEON data portal >>> pardat = stack_by_table("/filepath/NEON_par.zip") @@ -1204,7 +1204,7 @@ def load_by_product(dpid, site="all", startdate=None, enddate=None, Download product-site-month data package files from NEON, stack, and load to the environment. Parameters - -------- + ---------------- dpid: Data product identifier in the form DP#.#####.### site: Either the string 'all', or one or more 4-letter NEON site codes startdate: Earliest date of data to download, in the form YYYY-MM @@ -1220,11 +1220,11 @@ def load_by_product(dpid, site="all", startdate=None, enddate=None, token: User specific API token (generated within neon.datascience user accounts). If omitted, download uses the public rate limit. Return - -------- + --------------- A folder on the local drive containing the set of data package files meeting the input criteria. Example - -------- + --------------- Download water quality data from COMO (Como Creek) in 2018 >>> wq = load_by_product(dpid="DP1.20288.001",site="COMO",