update README

This commit is contained in:
Pim Nelissen
2026-01-27 15:37:07 +01:00
parent 0d37238794
commit 623f610c8f

View File

@ -1,2 +1,35 @@
# pg-rad # 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
```