From 623f610c8f2c503389b0b79c9f375167856f2a28 Mon Sep 17 00:00:00 2001 From: Pim Nelissen Date: Tue, 27 Jan 2026 15:37:07 +0100 Subject: [PATCH] update README --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1cb3cf5..60041f5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ # pg-rad -Primary Gamma RADiation landscape +Primary Gamma RADiation landscape - Development + +## Clone +``` +git clone https://github.com/pim-n/pg-rad +cd pg-rad +git checkout dev +``` + +or + +``` +git@github.com:pim-n/pg-rad.git +cd pg-rad +git checkout dev +``` + +## Dependencies / venv + +With Python verion `>=3.12.4`, create a virtual environment and install pg-rad. + +``` +python3 -m venv .venv +source .venv/bin/activate +(venv) pip install -e .[dev] +``` + +## Tests + +Tests can be run with `pytest` from the root directory of the repository. + +``` +(venv) pytest +``` \ No newline at end of file