Metadata-Version: 2.4
Name: rcpchgrowth
Version: 4.5.0
Summary: SDS and Centile calculations for UK Growth Data
Author-email: RCPCH Incubator <incubator@rcpch.ac.uk>
Maintainer-email: RCPCH Incubator <incubator@rcpch.ac.uk>
License-Expression: AGPL-3.0-or-later
Project-URL: Homepage, https://github.com/rcpch/rcpchgrowth-python
Project-URL: Bug Reports, https://github.com/rcpch/rcpchgrowth-python/issues
Project-URL: API management, https://dev.rcpch.ac.uk
Project-URL: Documentation, https://growth.rcpch.ac.uk/products/python-library/
Keywords: growth charts,anthropometry,SDS,centile,UK-WHO,UK90,Trisomy 21,Turner,CDC
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: python-dateutil
Requires-Dist: scipy
Provides-Extra: notebook
Requires-Dist: pandas>=1.5; extra == "notebook"
Requires-Dist: matplotlib>=3.7; extra == "notebook"
Requires-Dist: jupyterlab; extra == "notebook"
Requires-Dist: ipykernel; extra == "notebook"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pandas>=1.5; extra == "dev"
Requires-Dist: bump2version; extra == "dev"
Dynamic: license-file

# RCPCHGrowth Python library

## Calculations for children's measurements against UK and international growth references.

[![PyPI version](https://img.shields.io/pypi/v/rcpchgrowth.svg?style=flat-square&labelColor=%2311a7f2&color=%230d0d58)](https://pypi.org/project/rcpchgrowth/)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg?style=flat-square&labelColor=%2311a7f2&color=%230d0d58)](https://www.gnu.org/licenses/agpl-3.0)
[![Binder](https://img.shields.io/badge/Binder-Binder?style=flat-square&labelColor=%2311a7f2&color=%230d0d58&logo=jupyter)](https://mybinder.org/v2/gh/rcpch/rcpchgrowth-python/live?urlpath=lab/tree/notebooks/Quickstart.ipynb)
[![Codespaces](https://img.shields.io/badge/Codespaces-Open_in_Cloud?style=flat-square&labelColor=%2311a7f2&color=%230d0d58&logo=github&logoColor=white)](https://codespaces.new/rcpch/rcpchgrowth-python?quickstart=1)

**For AI/LLM agents working on this repository:** Please read [AGENTS.md](AGENTS.md) for project context, development workflow, and testing strategy.

Please go to <https://growth.rcpch.ac.uk/products/python-library/> for full documentation.

Issues can be raised here <https://github.com/rcpch/rcpchgrowth-python/issues>

---

## Installation

### Docker

If you want to avoid setting up docker environments, there are shortcut scripts the create a dockerized environment with RCPCHGrowth already installed.

This will generate a container which will launch some Jupyter notebooks in a browser and allow local dev (with hot reload).

#### Convenience Scripts

The `s/` folder contains helper scripts for common development tasks:

| Script | Purpose |
|--------|---------|
| `s/up` | Start the development container |
| `s/down` | Stop the development container |
| `s/test` | Run pytest (auto-starts container if needed; use `--running` flag for already-running container) |
| `s/notebook` | Launch JupyterLab in your browser |
| `s/shell` | Open an interactive bash shell in the container |
| `s/python` | Launch Python REPL in the container |

**Quick start:**

```bash
# Start the container and launch notebooks
s/notebook

# Run tests (in a separate terminal)
s/test

# Or run tests in an already-running container
s/test --running

# Run the UK-WHO integration suite
s/test rcpchgrowth/tests/test_uk_who.py -v

# Reference WHO test datasets and under-2 gold-standard rationale
# (192 deterministic anthro-generated cases)
# See rcpchgrowth/tests/who_test_data/README.md

# Stop when done
s/down
```

### Minimal installation (without docker) assuming you have a python virtual env setup

```bash
pip install rcpchgrowth
```

With notebook & package dependencies:

```bash
pip install "rcpchgrowth[notebook]"
```

The `notebook` extra currently pulls in: `pandas`, `matplotlib`, `jupyterlab`, `ipykernel`.

## Data handling / privacy

<table>
<tr>
  <td width="6" style="background:#11A7F2;"></td>
  <td>
    <strong>Data handling & privacy</strong><br>
    <strong>Never commit identifiable patient data.</strong><br>
    • Keep raw identifiable data outside version control (secure, access‑controlled).<br>
    • De‑identify before analysis (remove names, NHS numbers, full DOB; date‑shift if required).<br>
    • Do not push raw exports to forks, PRs or gists.<br>
    • Use <code>ResearchTemplate.ipynb</code> for generating de‑identified derived outputs.<br>
    <em>If in doubt, stop and seek local information governance guidance.</em>
  </td>
</tr>
</table>


---

## Contributing

See issues list and please open discussions before large changes.

---

Copyright © Royal College of Paediatrics and Child Health
