Metadata-Version: 2.4
Name: gpuwm-data
Version: 2.8.0
Summary: Physics reference tables and map assets for gpuwm (RRTMGP k-distributions, Thompson microphysics lookups, Natural Earth and US Census basemaps)
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/FahrenheitResearch/arwen
Project-URL: Repository, https://github.com/FahrenheitResearch/arwen
Keywords: WRF,RRTMGP,Thompson,weather,gpuwm
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

# gpuwm-data

Physics reference tables and map assets for [`gpuwm`](https://pypi.org/project/gpuwm/).

Install `gpuwm` and this arrives with it:

```
pip install gpuwm
```

You do not install this package by hand and you do not choose it. `gpuwm`
declares `gpuwm-data==<its own version>` as a hard dependency, because a
`gpuwm` 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. The 2.5.0 `gpuwm` wheel measured
103.62 MiB. These two directories of pure reference data were 64.21 MiB of
that, so they ship here and `gpuwm` ships at 39.41 MiB.

## What is in it

| Directory | Contents |
| --- | --- |
| `gpuwm_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 |
| `gpuwm_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` |
| `gpuwm_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 `gpuwm` 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 published as GitHub release assets and staged
by `gpuwm fetch-tables`, byte-verified against the pins in
`gpuwm.core.thompson_contract`. Only `mp_physics=8`/`28` runs need them.

## Reading it

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

```python
import gpuwm_data
gpuwm_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 `gpuwm`'s own
`gpuwm/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/FahrenheitResearch/arwen
