' + + '' + + _("Hide Search Matches") + + "
" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/docs/_html/api.html b/docs/_html/api.html new file mode 100644 index 0000000..135745a --- /dev/null +++ b/docs/_html/api.html @@ -0,0 +1,124 @@ + + + + + + + +
|
+This function queries the API for AOP data by site, year, and product, and downloads all files found, preserving the original folder structure. |
+
|
+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. |
+
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.
+The identifier of the NEON data product to pull, in the form DPL.PRNUM.REV, e.g. DP3.30001.001.
+The four-letter code of a single NEON site, e.g. ‘CLBJ’.
+The four-digit year to search for data.
+Should provisional data be downloaded? Defaults to False. See +https://www.neonscience.org/data-samples/data-management/data-revisions-releases +for details on the difference between provisional and released data.
+Should the user approve the total file size before downloading? Defaults to True. +If you have sufficient storage space on your local drive, when working +in batch mode, or other non-interactive workflow, use check_size=False.
+The file path to download to. Defaults to None, in which case the working directory is used.
+Size in bytes of chunk for chunked download. Defaults to 1024.
+User-specific API token generated within neon.datascience user accounts.
+None
+ValueError: If dpid is not formatted as expected. +ValueError: If field spectra data are attempted with the given dpid. +ValueError: If site is not a 4-letter character string. +ValueError: If year is not a valid year format, or is not > 2010
+>>> by_file_aop(dpid="DP3.30015.001", site="MCRA", year="2021", savepath="./test_download")
+# This will download 2021 CHM data from MCRA to the './test_download' directory.
+The function creates a folder in the ‘savepath’ directory, containing all AOP files meeting the query criteria. +If ‘savepath’ is not provided, it uses the working directory.
+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 +overload, which may take a long time.
+The identifier of the NEON data product to pull, in the form DPL.PRNUM.REV, e.g. DP3.30001.001.
+The four-letter code of a single NEON site, e.g. ‘CLBJ’.
+The four-digit year to search for data.
+A number or list containing the easting UTM coordinate(s) of the locations to download.
+A number or list containing the northing UTM coordinate(s) of the locations to download.
+Size, in meters, of the buffer to be included around the coordinates when determining which tiles to download. Defaults to 0. +If easting and northing coordinates are the centroids of NEON TOS plots, use buffer = 20.
+Should provisional data be downloaded? Defaults to False. See +https://www.neonscience.org/data-samples/data-management/data-revisions-releases +for details on the difference between provisional and released data.
+Should the user approve the total file size before downloading? Defaults to True. +If you have sufficient storage space on your local drive, when working +in batch mode, or other non-interactive workflow, use check_size=False.
+The file path to download to. Defaults to None, in which case the working directory is used. +It can be a string or a pathlib.Path object.
+Size in bytes of chunk for chunked download. Defaults to 1024.
+User-specific API token generated within neon.datascience user accounts.
+If set to True, the function will print information about the downloaded tiles.
+A folder in the working directory, containing all AOP files meeting query criteria.
+ValueError: If dpid is not formatted as expected. +ValueError: If field spectra data (DP1.30012.001) are provided as the dpid. +ValueError: If site is not a 4-letter character string. +ValueError: If year is not a valid year format, or is not > 2010. +ValueError: If easting is invalid. +ValueError: If northing is invalid. +ImportError: If pyproj is not installed.
+Download 2021 CHM data from MCRA at a single point: +by_tile_aop(dpid=”DP3.30015.001”, site=”MCRA”,easting = , northing = ,
+++year=”2021”, savepath=”../../test_download”)
+
The neonutilities Python package provides utilities for discovering, downloading, +and working with data files published by the National Ecological Observatory +Network (NEON). neonutilities provides functions +for downloading all types of NEON data (tabular, hierarchical, image) and for +joining tabular data files across dates and sites.
+neonutilities has several Python package dependencies including:
+pandas, pyarrow, pyproj, requests.
+Installing with pip should generally install dependencies as well; if there is a
+problem, use the requirements file in the package documentation.
pip install neonutilities
We recommend installing from PyPi, because the versions of the package hosted there +have been finalized. The development version on GitHub is likely to be unstable as +updates may be in progress. To install the development version anyway:
+pip install git+https://github.com/NEONScience/NEON-utilities-python.git@main
Once neonutilities is installed you can import it into python:
+>>> import neonutilities as nu
+For further instructions in using the package, see Tutorials.
+Add your content using reStructuredText syntax. See the
+reStructuredText
+documentation for details.
Contents:
+ ++ Searching for multiple words only shows matches that contain + all words. +
+ + + + + + + + +If you are new to using National Ecological Observatory +Network (NEON) data, we recommend +checking out the NEON overview video +and webpage and the resources on the +Getting Started +page.
+For tutorials specific to the neonutilities package, start with the
+Download and Explore NEON Data tutorial
For more details about neonutilities functions and function inputs, see the
+neonUtilities tutorial
neonUtilities cheat sheet