partial documentation

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: be41ee23646c19720eee73bfc1839ecc
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_html/.buildinfo.bak

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: fc097003c4d6099bdc7a2dd29b891cf3
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_html/_sources/api.rst.txt

@@ -0,0 +1,8 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+
+   neonutilities.aop_download.by_file_aop
+   neonutilities.aop_download.by_tile_aop

docs/_html/_sources/generated/neonutilities.aop_download.by_file_aop.rst.txt

@@ -0,0 +1,6 @@
+neonutilities.aop\_download.by\_file\_aop
+=========================================
+
+.. currentmodule:: neonutilities.aop_download
+
+.. autofunction:: by_file_aop

docs/_html/_sources/generated/neonutilities.aop_download.by_tile_aop.rst.txt

@@ -0,0 +1,6 @@
+neonutilities.aop\_download.by\_tile\_aop
+=========================================
+
+.. currentmodule:: neonutilities.aop_download
+
+.. autofunction:: by_tile_aop

docs/_html/_sources/getting-started.rst.txt

@@ -0,0 +1,30 @@
+Get started with neonutilities
+==================================================
+
+The neonutilities Python package provides utilities for discovering, downloading, 
+and working with data files published by the `National Ecological Observatory 
+Network (NEON) <https://www.neonscience.org/>`_. neonutilities provides functions 
+for downloading all types of NEON data (tabular, hierarchical, image) and for 
+joining tabular data files across dates and sites.
+
+Install neonutilities
+--------------------------------------------
+
+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 <https://github.com/NEONScience/NEON-utilities-python/blob/main/requirements.txt>`_ 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.

docs/_html/_sources/index.rst.txt

@@ -0,0 +1,20 @@
+.. neonutilities documentation master file, created by
+   sphinx-quickstart on Mon Nov  4 08:26:55 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+neonutilities documentation
+===========================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   getting-started
+   tutorials
+   api

docs/_html/_sources/tutorials.rst.txt

@@ -0,0 +1,18 @@
+Tutorials
+========================
+
+If you are new to using `National Ecological Observatory 
+Network (NEON) <https://www.neonscience.org/>`_ data, we recommend 
+checking out the `NEON overview <https://www.youtube.com/watch?v=39YrzpxVRF8>`_ video 
+and `webpage <https://www.neonscience.org/about/overview>`_ and the resources on the 
+`Getting Started <https://www.neonscience.org/resources/getting-started-neon-data-resources>`_ 
+page.
+
+For tutorials specific to the neonutilities package, start with the 
+
+* `Download and Explore NEON Data <https://www.neonscience.org/resources/learning-hub/tutorials/download-explore-neon-data>`_ tutorial
+
+For more details about neonutilities functions and function inputs, see the
+
+* `neonUtilities <https://www.neonscience.org/resources/learning-hub/tutorials/neondatastackr>`_ tutorial
+* `neonUtilities <https://www.neonscience.org/sites/default/files/cheat-sheet-neonUtilities_0.pdf>`_ cheat sheet