Metadata-Version: 2.4
Name: wxflow
Version: 0.3.0
Summary: Tools for Weather Workflows
Home-page: https://github.com/noaa-emc/wxflow
Author: NOAA/NWS/NCEP/EMC
License: GNU Lesser General Public License v3 (LGPLv3)
Project-URL: Bug Tracker, https://github.com/noaa-emc/wxflow/issues
Project-URL: CI, https://github.com/noaa-emc/wxflow/actions
Keywords: NOAA,NWS,NCEP,EMC
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
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: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy>=1.21.6
Requires-Dist: PyYAML>=6.0
Requires-Dist: Jinja2>=3.1.2
Provides-Extra: dev
Requires-Dist: pytest>=7; extra == "dev"
Requires-Dist: pytest-mock>=3; extra == "dev"
Requires-Dist: pytest-cov>=3; extra == "dev"
Requires-Dist: isort>=5; extra == "dev"
Requires-Dist: pycodestyle>=2; extra == "dev"
Requires-Dist: pre-commit>=2; extra == "dev"
Requires-Dist: tox>=3; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=4; extra == "docs"
Requires-Dist: sphinx-autobuild; extra == "docs"
Requires-Dist: sphinx_rtd_theme>=0.5; extra == "docs"
Requires-Dist: furo>=2023.03.23; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Dynamic: license-file

![PyPI](https://img.shields.io/pypi/v/wxflow)
[![pynorms](https://github.com/NOAA-EMC/wxflow/actions/workflows/pynorms.yaml/badge.svg)](https://github.com/NOAA-EMC/wxflow/actions/workflows/pynorms.yaml)
[![pytests](https://github.com/NOAA-EMC/wxflow/actions/workflows/pytests.yaml/badge.svg)](https://github.com/NOAA-EMC/wxflow/actions/workflows/pytests.yaml)
[![Documentation Status](https://readthedocs.org/projects/wxflow/badge/?version=latest)](https://wxflow.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/noaa-emc/wxflow/branch/develop/graph/badge.svg?token=JWTPE8Z7MH)](https://codecov.io/gh/noaa-emc/wxflow)

# Tools for Weather Workflows

Common set of tools used in weather workflows

### Installation
```sh
$> pip install wxflow
```

### Running python tests:
Simple instructions to enable executing pytests manually
```sh
# Create a python virtual environment and step into it
$> cd wxflow
$> python3 -m venv venv
$> source venv/bin/activate

# Install `wxflow` with the developer requirements
(venv) $> pip install .[dev]
# NOTE: on a macOS, may need to specify ."[dev]" if using zsh

# Run pytests
(venv) $> pytest -v
```
### Documentation
Documentation is automatically generated and is available [here](https://wxflow.readthedocs.io/en/latest/).

# Disclaimer

The United States Department of Commerce (DOC) GitHub project code is provided
on an "as is" basis and the user assumes responsibility for its use. DOC has
relinquished control of the information and no longer has responsibility to
protect the integrity, confidentiality, or availability of the information. Any
claims against the Department of Commerce stemming from the use of its GitHub
project will be governed by all applicable Federal law. Any reference to
specific commercial products, processes, or services by service mark,
trademark, manufacturer, or otherwise, does not constitute or imply their
endorsement, recommendation or favoring by the Department of Commerce. The
Department of Commerce seal and logo, or the seal and logo of a DOC bureau,
shall not be used in any manner to imply endorsement of any commercial product
or activity by DOC or the United States Government.
