Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ neonutilities
[![Python Package](https://img.shields.io/github/actions/workflow/status/NEONScience/NEON-utilities-python/python-package.yml)](https://github.com/NEONScience/NEON-utilities-python/actions/workflows/python-package.yml)
[![Documentation Status](https://readthedocs.org/projects/neon-utilities-python/badge/?version=latest)](https://neon-utilities-python.readthedocs.io/en/latest/?badge=latest)
[![PyPI version shields.io](https://img.shields.io/pypi/v/neonutilities.svg)](https://pypi.org/project/neonutilities/)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/neonutilities.svg)](https://anaconda.org/conda-forge/neonutilities)
[![PyPI license](https://img.shields.io/github/license/NEONScience/NEON-utilities-python)](https://github.com/NEONScience/NEON-utilities-python/blob/main/LICENSE)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://img.shields.io/badge/repo%20status-Active-Green)](https://www.repostatus.org/#active)
[![pyOpenSci Peer-Reviewed](https://pyopensci.org/badges/peer-reviewed.svg)](https://github.com/pyOpenSci/software-review/issues/issue-number)
Expand All @@ -13,15 +14,15 @@ neonutilities

The neonutilities Python package provides utilities for discovering, downloading, and working with data files published by the National Ecological Observatory Network (NEON). NEON data files can be downloaded from the NEON Data Portal (http://data.neonscience.org) or API (http://data.neonscience.org/data-api). NEON data files from Instrumented and Observation Systems (IS and OS) are delivered by NEON in tabular files organized by site and year-month. NEON data files from the Airborne Observation Platform (AOP) are organized by site and year.

neonutilities is available on PyPI and most users will want to install it from there. If you want to use the current development version, you can install from GitHub, but be warned that the GitHub version may not be stable.
neonutilities is available on [PyPI](https://pypi.org/project/neonutilities/) and [conda-forge](https://github.com/conda-forge/neonutilities-feedstock) and most users will want to install it from these locations. If you want to use the current development version, you can install from GitHub, but be warned that the GitHub version may not be stable.

Brief examples below; see documentation on [Read the Docs](https://neon-utilities-python.readthedocs.io/en/latest/) and [NEON Data Tutorials](https://www.neonscience.org/resources/learning-hub/tutorials) for more information, particularly the [Download and Explore](https://www.neonscience.org/resources/learning-hub/tutorials/download-explore-neon-data) and [neonUtilities](https://www.neonscience.org/resources/learning-hub/tutorials/neondatastackr) tutorials.

```
$ pip install neonutilities
```

```
```python
import neonutilities as nu
import os

Expand Down
89 changes: 75 additions & 14 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,90 @@
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
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:
neonutilities has several Python package dependencies including:
``pandas, pyarrow, pyproj, requests``.
Installing with pip should generally install dependencies as well; if there is a

From `PyPI <https://pypi.org/project/neonutilities/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Installing with ``pip`` or ``uv`` will 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``
.. code-block:: shell

# with pip
pip install neonutilities

.. code-block:: shell

# with uv
uv pip install neonutilities

From `conda-forge <https://github.com/conda-forge/neonutilities-feedstock>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can setup an environment that includes all dependencies (including Python)
with the following command line operations.

With Pixi
~~~~~~~~~

`Pixi <https://pixi.sh/>`_ environments are fully reproducible by default.
From your project directory, initialize a Pixi workspace and then add ``neonutilities``

.. code-block:: shell

pixi init
pixi add neonutilities

You can optionally activate an interactive shell with the environment loaded with

.. code-block:: shell

pixi shell

With conda
~~~~~~~~~~

Create a `conda <https://docs.conda.io/>`_ environment and install ``neonutilities`` from the ``conda-forge`` channel

.. code-block:: shell

conda create --name neon-env
conda config --name neon-env --add channels conda-forge
conda config --name neon-env --remove channels defaults
conda install --name neon-env neonutilities

and then activate the conda environment

.. code-block:: shell

conda activate neon-env

From GitHub
^^^^^^^^^^^

We recommend installing from the above package indexes, 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:

.. code-block:: shell

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

``pip install git+https://github.com/NEONScience/NEON-utilities-python.git@main``
Once neonutilities is installed you can import it into Python:

Once neonutilities is installed you can import it into python:
.. code-block:: python

>>> import neonutilities as nu

Expand Down