Metadata-Version: 2.4
Name: nldi-xstool
Version: 0.13.0
Summary: Nldi Xstool
Project-URL: Homepage, https://code.usgs.gov/wma/nhgf/toolsteam/nldi-xstool
Project-URL: Repository, https://code.usgs.gov/wma/nhgf/toolsteam/nldi-xstool
Project-URL: Documentation, https://nldi-xstool.readthedocs.io
Project-URL: Changelog, https://code.usgs.gov/wma/nhgf/toolsteam/nldi-xstool/-/releases
Author-email: Richard McDonald <rmcd@usgs.gov>
License: # License
        
        Unless otherwise noted, This project is in the public domain in the United
        States because it contains materials that originally came from the United
        States Geological Survey, an agency of the United States Department of
        Interior. For more information, see the official USGS copyright policy at
        https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits
        
        Additionally, we waive copyright and related rights in the work
        worldwide through the CC0 1.0 Universal public domain dedication.
        
        ## CC0 1.0 Universal Summary
        
        This is a human-readable summary of the
        [Legal Code (read the full text)][1].
        
        ### No Copyright
        
        The person who associated a work with this deed has dedicated the work to
        the public domain by waiving all of his or her rights to the work worldwide
        under copyright law, including all related and neighboring rights, to the
        extent allowed by law.
        
        You can copy, modify, distribute and perform the work, even for commercial
        purposes, all without asking permission.
        
        ### Other Information
        
        In no way are the patent or trademark rights of any person affected by CC0,
        nor are the rights that other persons may have in the work or in how the
        work is used, such as publicity or privacy rights.
        
        Unless expressly stated otherwise, the person who associated a work with
        this deed makes no warranties about the work, and disclaims liability for
        all uses of the work, to the fullest extent permitted by applicable law.
        When using or citing the work, you should not imply endorsement by the
        author or the affirmer.
        
        [1]: https://creativecommons.org/publicdomain/zero/1.0/legalcode
License-File: LICENSE.md
Classifier: Development Status :: 1 - Planning
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: <3.15,>=3.10
Requires-Dist: bottleneck>1.3.4
Requires-Dist: click<9,>=8.0
Requires-Dist: dask>=2024.5.1
Requires-Dist: geopandas>0.11.0
Requires-Dist: netcdf4>=1.5.8
Requires-Dist: numba>=0.55.1
Requires-Dist: numpy<3,>=2
Requires-Dist: py3dep<0.20,>=0.19.0
Requires-Dist: pygeoapi>=0.11.0
Requires-Dist: pygeohydro<0.20,>=0.19.0
Requires-Dist: pynhd<0.20,>=0.19.0
Requires-Dist: shapely<3,>=2
Requires-Dist: xarray>2022.3.0
Description-Content-Type: text/markdown

# Nldi Xstool

[![PyPI](https://img.shields.io/pypi/v/nldi-xstool.svg)](https://pypi.org/project/nldi-xstool/)
[![Status](https://img.shields.io/pypi/status/nldi-xstool.svg)](https://pypi.org/project/nldi-xstool/)
[![Python Version](https://img.shields.io/pypi/pyversions/nldi-xstool)](https://pypi.org/project/nldi-xstool)
[![License](https://img.shields.io/pypi/l/nldi-xstool)](https://creativecommons.org/publicdomain/zero/1.0/legalcode)

[![Read the documentation at https://nldi-xstool.readthedocs.io/](https://img.shields.io/readthedocs/nldi-xstool/latest.svg?label=Read%20the%20Docs)](https://nldi-xstool.readthedocs.io/)

[![pipeline status](https://code.usgs.gov/wma/nhgf/toolsteam/nldi-xstool/badges/main/pipeline.svg)](https://code.usgs.gov/wma/nhgf/toolsteam/nldi-xstool/-/commits/main)
[![coverage report](https://code.usgs.gov/wma/nhgf/toolsteam/nldi-xstool/badges/main/coverage.svg)](https://code.usgs.gov/wma/nhgf/toolsteam/nldi-xstool/-/commits/main)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)

## Features

- Generate topographic cross-sections using the USGS [National Linked Data Infrastructure (NLDI)](https://waterdata.usgs.gov/blog/nldi-intro/) and [3D Elevation Program (3DEP)](https://www.usgs.gov/3d-elevation-program) services
- Three CLI commands for different cross-section workflows:
  - `xsatpoint` — cross-section at a point, snapped to the nearest NHD stream segment
  - `xsatendpts` — cross-section between user-defined start and end points
  - `xsatpathpts` — cross-section along a user-defined path
- Configurable DEM resolution: 1m, 3m, 5m, 10m, 30m, or 60m
- Output as GeoJSON with support for CRS projection
- Also available as a [pygeoapi](https://pygeoapi.io/) process plugin

## Requirements

- Python 3.10–3.14

## Installation

You can install _nldi-xstool_ via [pip](https://pip.pypa.io/) from [PyPI](https://pypi.org/):

```console
pip install nldi-xstool
```

Or with [uv](https://github.com/astral-sh/uv):

```console
uv add nldi-xstool
```

## Command Line Usage

Please see the [Usage](https://nldi-xstool.readthedocs.io/en/latest/usage.html) documentation.

## Contributing

Contributions are very welcome.
To learn more, see the [Contributing Guide](https://nldi-xstool.readthedocs.io/en/latest/contributing.html).

## License

Distributed under the terms of the [CC0 1.0 Universal license](https://creativecommons.org/publicdomain/zero/1.0/legalcode),
_Nldi Xstool_ is free and open source software.

## Disclaimer

See the [Disclaimer](https://nldi-xstool.readthedocs.io/en/latest/disclaimer.html).

## Issues

If you encounter any problems,
please [file an issue](https://code.usgs.gov/wma/nhgf/toolsteam/nldi-xstool/-/issues) along with a detailed description.

## Credits

This project was generated from
[@hillc-usgs](https://github.com/hillc-usgs)'s [Pygeoapi Plugin
Cookiecutter](https://code.usgs.gov/wma/nhgf/pygeoapi-plugin-cookiecutter)
template.
