Metadata-Version: 2.3
Name: qc-core
Version: 0.0.4
Summary: Core operations that are used across the QuantClimate stack.
Author: Thomas Pinder
Author-email: Thomas Pinder <thomas@quantclimate.com>
Requires-Dist: matplotlib>=3.11.1
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# qc-core

Shared Python utilities for QuantClimate. The package includes the Calibrated Ledger Matplotlib style and plotting helpers.

## Installation

```bash
pip install qc-core
```

qc-core requires Python 3.11 or later.

## Matplotlib style

Load the packaged style globally:

```python
import qc_core

qc_core.use_ledger_style()
```

Use the plotting module for the complete plotting API:

```python
from qc_core import plotting

plotting.use_ledger_style()
```

`qc_core.style_path()` returns the installed style file's path.

## Fonts

The style sets labels, ticks and legends in Noto Sans. The Regular, SemiBold
and Bold files ship with the package, and `use_ledger_style()` registers them
with Matplotlib, so you do not need to install the font. If you load the style
file directly, call `qc_core.plotting.register_fonts()` first.

Noto Sans is licensed under the SIL Open Font License 1.1. The licence is in
`src/qc_core/fonts/OFL.txt`.
