Metadata-Version: 2.4
Name: recast-woof-data
Version: 1.0.0
Summary: Physics reference tables and map assets for Recast WOOF (RRTMGP k-distributions, Thompson microphysics lookups, Natural Earth and US Census basemaps)
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/recastsystems/woof
Project-URL: Repository, https://github.com/recastsystems/woof
Keywords: WRF,RRTMGP,Thompson,weather,woof
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
License-File: licenses/LICENSE-RTE-RRTMGP-BSD-3-Clause.txt
License-File: licenses/LICENSE-WRF-public-domain.txt
License-File: licenses/NOTICE-Numerical-Recipes.txt
Dynamic: license-file

# recast-woof-data

Physics reference tables and map assets for [Recast WOOF](https://pypi.org/project/recast-woof/).

Install `recast-woof` and this arrives with it:

```
pip install recast-woof
```

You do not install this package by hand and you do not choose it.
`recast-woof` declares `recast-woof-data==<its own version>` as a hard
dependency, because a WOOF install that cannot run radiation or Thompson
microphysics is not an install. There is no extra to remember and no
post-install step.

## Why it is a separate distribution

PyPI rejects any file over 100 MiB. With these two directories inside it,
the engine's wheel measured 103.62 MiB. They are 64.21 MiB of pure
reference data, so they ship here and the engine's wheel stays under the
limit.

## What is in it

| Directory | Contents |
| --- | --- |
| `woof_data/data/rrtmgp/` | RTE+RRTMGP k-distribution and cloud-optics NetCDFs, the trace-gas climatology RRTMGP derives from the RFMIP inputs, and the license and provenance texts that document them |
| `woof_data/data/thompson/tables/` | The Thompson microphysics lookup tables generated by WRF v4.6.1's `thompson_init`, plus `CCN_ACTIVATE.BIN` for the aerosol-aware variant, under `MANIFEST.sha256` |
| `woof_data/data/basemap/` | The Natural Earth and US Census shapefiles the renderer draws coastlines, borders, state lines and counties from |

Every byte is data. There is no compiled code and no platform coupling,
so one `py3-none-any` wheel serves every platform WOOF runs on.

Two of the Thompson tables are **not** here: `freezeH2O.dat` (243 MiB) and
`qr_acr_qg_V4.dat` (71 MiB) are each over the same PyPI limit that split
this package out. They are assets of WOOF's `v1.0.0` GitHub release and
are staged by `woof fetch-tables`, byte-verified against the pins in
`woof.core.thompson_contract`. Only `mp_physics=8`/`28` runs need them.

## Reading it

WOOF resolves these paths through `woof.data_assets`, which is the only
supported way in. If you want the directory yourself:

```python
import woof_data
woof_data.data_root() / "rrtmgp" / "rrtmgp-gas-lw-g256.nc"
```

## Provenance and licensing

The code here is Apache-2.0. The **data** is not uniformly so, and each
directory carries its own texts: see `data/rrtmgp/PROVENANCE.md` with its
`LICENSE` and `LICENSE-CC-BY-SA-4.0` files, and the `woof` package's own
`woof/data/thompson/PROVENANCE.md` for the WRF-derived Thompson tables.
The map assets are public domain; `data/basemap/PROVENANCE.md` names their
sources.
No RFMIP file is carried here or in the source repository: the four
reference results are CC-BY-NC-SA-4.0 and the input file's terms are
ambiguous, so the tests that read them fetch them from upstream at test
time, and RRTMGP runs on a 136-number table derived from the inputs.

Source and issues: https://github.com/recastsystems/woof
