arl-met
=======

.. image:: https://github.com/jmineau/arl-met/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/jmineau/arl-met/actions/workflows/tests.yml
   :alt: Tests

.. image:: https://github.com/jmineau/arl-met/actions/workflows/docs.yml/badge.svg
   :target: https://github.com/jmineau/arl-met/actions/workflows/docs.yml
   :alt: Documentation

.. image:: https://github.com/jmineau/arl-met/actions/workflows/quality.yml/badge.svg
   :target: https://github.com/jmineau/arl-met/actions/workflows/quality.yml
   :alt: Code Quality

.. image:: https://codecov.io/gh/jmineau/arl-met/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/jmineau/arl-met
   :alt: Code Coverage

.. image:: https://badge.fury.io/py/arlmet.svg
   :target: https://badge.fury.io/py/arlmet
   :alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/arlmet.svg
   :target: https://pypi.org/project/arlmet/
   :alt: Python Version

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
   :alt: License

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
   :target: https://github.com/astral-sh/ruff
   :alt: Ruff

.. image:: https://img.shields.io/badge/pyright-checked-brightgreen.svg
   :target: https://github.com/microsoft/pyright
   :alt: Pyright

Read and analyze ARL meteorological files.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   quickstart
   format
   api
   contributing

.. include:: installation.rst

.. include:: quickstart.rst

.. include:: api.rst

Contributing
============

See the `CONTRIBUTING.md <https://github.com/jmineau/arl-met/blob/main/CONTRIBUTING.md>`_ file for guidelines on how to contribute to this project.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`