Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions .binder/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
rcpchgrowth
pandas>=1.5
matplotlib>=3.7
jupyterlab
ipykernel
-e ".[notebook]"
1 change: 0 additions & 1 deletion MANIFEST.in

This file was deleted.

29 changes: 3 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

[![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-Launch?style=flat-square&labelColor=%2311a7f2&color=%230d0d58&logo=binder&logoColor=white)](https://mybinder.org/v2/gh/rcpch/rcpchgrowth-python/live?labpath=notebooks%2FQuickstart.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)

Please go to <https://growth.rcpch.ac.uk/products/python-library/> for full documentation.
Expand All @@ -19,19 +18,13 @@ Issues can be raised here <https://github.com/rcpch/rcpchgrowth-python/issues>

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

First ensure the folders have the correct permissions:
This will generate a container which will launch some Jupyter notebooks in a browser and allow local dev ( with hot reload).

```bash
chmod +x s/dev
s/up
```

To generate a container which will launch the notebooks in a browser and allow local dev ( with hot reload)

```bash
s/dev
```

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

```bash
pip install rcpchgrowth
Expand All @@ -45,22 +38,6 @@ pip install "rcpchgrowth[notebook]"

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

To verify versions inside a Jupyter session:

```python
import rcpchgrowth, pandas as pd, sys
print(rcpchgrowth.__version__, pd.__version__, sys.version)
```

## Example notebooks

Example notebooks live in `notebooks/`:

- `Quickstart.ipynb` – single measurement, small batch, simple plot.
- `ResearchTemplate.ipynb` – structured workflow for batch CSV processing (ages, SDS, centiles, quality flags, export).
- `AdditionalFunctions.ipynb` - exposes some of the date and calculation functions for more in-depth exploration
- `ExperimentalFunctions.ipynb` - exposes functions that are in development and more experimental

## Data handling / privacy

<table>
Expand Down
1 change: 0 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
version: "3.9"
services:
dev:
build: .
Expand Down
5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,5 @@ exclude = ["notebooks"]
file = "README.md"
content-type = "text/markdown"

# Future: you can move package-data patterns here instead of MANIFEST.in if desired:
# [tool.setuptools.package-data]
# rcpchgrowth = ["data_tables/**/*.csv", "data_tables/**/*.json"]
[tool.setuptools.package-data]
rcpchgrowth = ["data_tables/**/*.csv", "data_tables/**/*.json", "data_tables/**/*.xls", "data_tables/**/*.pdf", "data_tables/**/*.bas", "data_tables/**/*.xlsx"]
18 changes: 0 additions & 18 deletions s/dev

This file was deleted.

20 changes: 0 additions & 20 deletions s/notebooks

This file was deleted.