Metadata-Version: 2.4
Name: qcore-utils
Version: 2026.10.1
Summary: Utils Library
Author: ucgmsim
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: pyproj
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: xarray
Requires-Dist: typing-extensions>=4.9.0
Provides-Extra: cli
Requires-Dist: typer; extra == "cli"
Requires-Dist: docstring_parser; extra == "cli"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: hypothesis[numpy]; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: types
Requires-Dist: pandas-stubs; extra == "types"
Requires-Dist: scipy-stubs; extra == "types"
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Requires-Dist: deptry; extra == "dev"
Requires-Dist: ty; extra == "dev"
Dynamic: license-file

[![Build Status](https://quakecoresoft.canterbury.ac.nz/jenkins/job/qcore/badge/icon?build=last:${params.ghprbActualCommit=master)](https://quakecoresoft.canterbury.ac.nz/jenkins/job/qcore)

## Installation:

To install run `pip install -e .` from the root directory of this repository

The `qcore.cli` helpers (`from_docstring`) need the optional `cli` extra, which pulls in typer and docstring_parser: `pip install 'qcore-utils[cli]'` (or `pip install -e '.[cli]'`).

### Downloading data after install

After installing, if you intend to use GMT for plotting you will need to run "download_data.py" (Located in qcore.data) to download and
unpack the data used for these scripts
