Add mkdocs backbone and minimal content

docs/API/landscape/create_landscape_from_path.md

@@ -0,0 +1,4 @@
+---
+title: pg_rad.landscape.create_landscape_from_path
+---
+::: pg_rad.landscape.create_landscape_from_path

docs/API/landscape/landscape.md

@@ -0,0 +1,4 @@
+---
+title: pg_rad.landscape.Landscape
+---
+::: pg_rad.landscape.Landscape

docs/API/objects/object.md

@@ -0,0 +1,5 @@
+---
+title: pg_rad.objects.Object
+---
+
+::: pg_rad.objects.Object

docs/API/path/path.md

@@ -0,0 +1,4 @@
+---
+title: pg_rad.path.Path
+---
+::: pg_rad.path.Path

docs/API/path/path_from_RT90.md

@@ -0,0 +1,5 @@
+---
+title: pg_rad.path.path_from_RT90
+---
+::: pg_rad.path.path_from_RT90
+

docs/API/path/simplify_path.md

@@ -0,0 +1,4 @@
+---
+title: pg_rad.path.simplify_path
+---
+::: pg_rad.path.simplify_path

docs/API/sources/point_source.md

@@ -0,0 +1,5 @@
+---
+title: pg_rad.sources.PointSource
+---
+
+::: pg_rad.sources.PointSource

docs/index.md

@@ -0,0 +1,45 @@
+# Welcome!
+
+Primary Gamma RADiation Landscapes (PG-RAD) is a Python package for research in source localization. It can simulate mobile gamma spectrometry data acquired from vehicle-borne detectors along a predefined path (e.g. a road).
+
+## Requirements
+
+PG-RAD requires Python `3.12`. The guides below assume a unix-like system.
+
+## Installation (CLI)
+
+<!--pipx seems like a possible option to install python package in a contained environment on unix-->
+
+Lorem ipsum
+
+## Installation (Python module)
+
+If you are interested in using PG-RAD in another Python project, create a virtual environment first:
+
+```
+python3 -m venv .venv
+```
+
+Then install PG-RAD in it:
+
+```
+source .venv/bin/activate
+(.venv) pip install git+https://github.com/pim-n/pg-rad
+```
+
+See how to get started with PG-RAD with your own Python code [here](pg-rad-in-python).
+
+## For developers
+```
+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
+```

docs/pg-rad-in-cli.md

@@ -0,0 +1,4 @@
+---
+title: Using PG-RAD in CLI
+---
+Lorem ipsum.

docs/pg-rad-in-python.md

@@ -0,0 +1,5 @@
+---
+title: Using PG-RAD as a module
+---
+
+Consult the API documentation in the side bar.