docs: set up MkDocs documentation structure with mkdocstrings

docs/api/config.md

@@ -0,0 +1,9 @@
+# Configuration
+
+::: neural_lam.config
+    options:
+      show_root_heading: true
+      show_source: true
+      docstring_style: numpy
+      members_order: source
+      show_submodules: true

docs/api/datastore.md

@@ -0,0 +1,8 @@
+# Datastore
+
+::: neural_lam.datastore.base.BaseDatastore
+    options:
+      show_root_heading: true
+      show_source: true
+      docstring_style: numpy
+      members_order: source

docs/api/metrics.md

@@ -0,0 +1,6 @@
+::: neural_lam.metrics
+    options:
+      show_root_heading: true
+      show_source: true
+      docstring_style: numpy
+      members_order: source

docs/api/models.md

@@ -0,0 +1,22 @@
+# Models
+
+::: neural_lam.models.graph_lam.GraphLAM
+    options:
+      show_root_heading: true
+      show_source: true
+      docstring_style: numpy
+      members_order: source
+
+::: neural_lam.models.hi_lam.HiLAM
+    options:
+      show_root_heading: true
+      show_source: true
+      docstring_style: numpy
+      members_order: source
+
+::: neural_lam.models.hi_lam_parallel.HiLAMParallel
+    options:
+      show_root_heading: true
+      show_source: true
+      docstring_style: numpy
+      members_order: source

docs/changelog.md

@@ -0,0 +1,5 @@
+# Changelog
+
+This page documents all notable changes to neural-lam.
+
+--8<-- "CHANGELOG.md"

docs/getting_started/installation.md

@@ -0,0 +1,21 @@
+# Installation
+
+## Requirements
+
+- Python >= 3.10
+- PyTorch >= 2.3.0
+
+## Install from source
+
+```bash
+git clone https://github.com/mllam/neural-lam.git
+cd neural-lam
+uv sync
+```
+
+## Development install
+
+```bash
+uv sync --group dev
+pre-commit install
+```

docs/getting_started/quickstart.md

@@ -0,0 +1,13 @@
+# Quick Start
+
+## Training a model
+
+```bash
+python -m neural_lam.train_model --config config.yaml
+```
+
+## Running tests
+
+```bash
+pytest tests/
+```

docs/index.md

@@ -0,0 +1,23 @@
+# neural-lam
+
+Graph-based neural weather prediction for Limited Area Modeling (LAM).
+
+## Overview
+
+neural-lam is a Python package for training and evaluating graph-based 
+neural network models for weather forecasting. It is developed by the 
+[MLLAM community](https://github.com/mllam).
+
+## Features
+
+- Graph Neural Network-based weather prediction
+- Support for Limited Area Modeling (LAM)
+- Flexible datastore interface
+- Multiple model architectures (GraphLAM, HiLAM, HiLAMParallel)
+
+## Quick Links
+
+- [Installation](getting_started/installation.md)
+- [Quick Start](getting_started/quickstart.md)
+- [API Reference](api/metrics.md)
+- [GitHub Repository](https://github.com/mllam/neural-lam)

mkdocs.yml

@@ -0,0 +1,44 @@
+site_name: neural-lam
+site_description: Graph-based neural weather prediction for Limited Area Modeling
+site_url: https://mllam.github.io/neural-lam
+repo_url: https://github.com/mllam/neural-lam
+repo_name: mllam/neural-lam
+
+theme:
+  name: material
+  palette:
+    primary: blue
+    accent: cyan
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - toc.integrate
+    - search.suggest
+
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            docstring_style: numpy
+            show_source: true
+            show_root_heading: true
+
+nav:
+  - Home: index.md
+  - Getting Started:
+    - Installation: getting_started/installation.md
+    - Quick Start: getting_started/quickstart.md
+  - API Reference:
+    - Metrics: api/metrics.md
+    - Models: api/models.md
+    - Datastore: api/datastore.md
+    - Configuration: api/config.md
+  - Changelog: changelog.md
+
+markdown_extensions:
+  - admonition
+  - pymdownx.highlight
+  - pymdownx.superfences
+  - pymdownx.snippets