From 9302af4624ca07e1ff520ecafa0690b1a8959a1c Mon Sep 17 00:00:00 2001 From: Pim Nelissen Date: Wed, 28 Jan 2026 09:39:55 +0100 Subject: [PATCH] Add mkdocs backbone and minimal content --- .../landscape/create_landscape_from_path.md | 4 ++ docs/API/landscape/landscape.md | 4 ++ docs/API/objects/object.md | 5 +++ docs/API/path/path.md | 4 ++ docs/API/path/path_from_RT90.md | 5 +++ docs/API/path/simplify_path.md | 4 ++ docs/API/sources/point_source.md | 5 +++ docs/index.md | 45 +++++++++++++++++++ docs/pg-rad-in-cli.md | 4 ++ docs/pg-rad-in-python.md | 5 +++ mkdocs.yml | 41 +++++++++++++++++ pyproject.toml | 2 +- 12 files changed, 127 insertions(+), 1 deletion(-) create mode 100644 docs/API/landscape/create_landscape_from_path.md create mode 100644 docs/API/landscape/landscape.md create mode 100644 docs/API/objects/object.md create mode 100644 docs/API/path/path.md create mode 100644 docs/API/path/path_from_RT90.md create mode 100644 docs/API/path/simplify_path.md create mode 100644 docs/API/sources/point_source.md create mode 100644 docs/index.md create mode 100644 docs/pg-rad-in-cli.md create mode 100644 docs/pg-rad-in-python.md create mode 100644 mkdocs.yml diff --git a/docs/API/landscape/create_landscape_from_path.md b/docs/API/landscape/create_landscape_from_path.md new file mode 100644 index 0000000..75c3b28 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/docs/API/landscape/landscape.md b/docs/API/landscape/landscape.md new file mode 100644 index 0000000..dc4c9a6 --- /dev/null +++ b/docs/API/landscape/landscape.md @@ -0,0 +1,4 @@ +--- +title: pg_rad.landscape.Landscape +--- +::: pg_rad.landscape.Landscape \ No newline at end of file diff --git a/docs/API/objects/object.md b/docs/API/objects/object.md new file mode 100644 index 0000000..188c8aa --- /dev/null +++ b/docs/API/objects/object.md @@ -0,0 +1,5 @@ +--- +title: pg_rad.objects.Object +--- + +::: pg_rad.objects.Object \ No newline at end of file diff --git a/docs/API/path/path.md b/docs/API/path/path.md new file mode 100644 index 0000000..302b51b --- /dev/null +++ b/docs/API/path/path.md @@ -0,0 +1,4 @@ +--- +title: pg_rad.path.Path +--- +::: pg_rad.path.Path \ No newline at end of file diff --git a/docs/API/path/path_from_RT90.md b/docs/API/path/path_from_RT90.md new file mode 100644 index 0000000..76f34ea --- /dev/null +++ b/docs/API/path/path_from_RT90.md @@ -0,0 +1,5 @@ +--- +title: pg_rad.path.path_from_RT90 +--- +::: pg_rad.path.path_from_RT90 + diff --git a/docs/API/path/simplify_path.md b/docs/API/path/simplify_path.md new file mode 100644 index 0000000..23294fb --- /dev/null +++ b/docs/API/path/simplify_path.md @@ -0,0 +1,4 @@ +--- +title: pg_rad.path.simplify_path +--- +::: pg_rad.path.simplify_path \ No newline at end of file diff --git a/docs/API/sources/point_source.md b/docs/API/sources/point_source.md new file mode 100644 index 0000000..5d7732e --- /dev/null +++ b/docs/API/sources/point_source.md @@ -0,0 +1,5 @@ +--- +title: pg_rad.sources.PointSource +--- + +::: pg_rad.sources.PointSource \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..ca4d696 --- /dev/null +++ b/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) + + + +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 +``` \ No newline at end of file diff --git a/docs/pg-rad-in-cli.md b/docs/pg-rad-in-cli.md new file mode 100644 index 0000000..fedb76c --- /dev/null +++ b/docs/pg-rad-in-cli.md @@ -0,0 +1,4 @@ +--- +title: Using PG-RAD in CLI +--- +Lorem ipsum. \ No newline at end of file diff --git a/docs/pg-rad-in-python.md b/docs/pg-rad-in-python.md new file mode 100644 index 0000000..8332390 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..659692d --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,41 @@ +site_name: PG-RAD Documentation +theme: + name: material + palette: + # Dark Mode + - scheme: slate + toggle: + icon: material/weather-sunny + name: Dark mode + primary: blue + accent: deep purple + + # Light Mode + - scheme: default + toggle: + icon: material/weather-night + name: Light mode + primary: light blue + accent: blue + features: + - content.code.copy + +markdown_extensions: + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + +plugins: +- mkdocstrings: + enabled: !ENV [ENABLE_MKDOCSTRINGS, true] + default_handler: python + locale: en + handlers: + python: + options: + show_source: false + show_root_heading: false \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 1b0ad50..033bb38 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -29,4 +29,4 @@ Homepage = "https://github.com/pim-n/pg-rad" Issues = "https://github.com/pim-n/pg-rad/issues" [project.optional-dependencies] -dev = ["pytest", "notebook"] \ No newline at end of file +dev = ["pytest", "notebook", "mkdocs-material", "mkdocstrings-python"] \ No newline at end of file