Docs

Author: maroba

README.md

@@ -1,7 +1,7 @@
 # bhut
 
 <div align="center">
-  <img src="docs/assets/logo-256.png" alt="bhut logo" width="200"/>
+  <img src="docs/assets/logo-256.svg" alt="bhut logo" width="200"/>
 </div>
 
 A high-performance Barnes-Hut N-body accelerator that is array-agnostic, supporting both NumPy and Dask arrays for distributed computation.

docs/dev/contributing.md

@@ -83,6 +83,16 @@ mypy bhut/
 mypy --strict bhut/
 ```
 
+## Documentation Preview
+
+To preview the documentation locally:
+
+```bash
+./scripts/preview_docs.sh
+```
+
+This script installs the required dependencies and starts a local server at http://localhost:8000. It is executable by default.
+
 ## Pull Request Guidelines
 
 ### Before Submitting

docs/theory/barnes-hut.md

@@ -57,6 +57,26 @@ To avoid singularities at small distances, a softening parameter $\epsilon$ is o
 
 $$\vec{F}_{ij} = -G \frac{m_i m_j}{(|\vec{r}_{ij}|^2 + \epsilon^2)^{3/2}} \vec{r}_{ij}$$
 
+## Plummer Softening
+
+We use Plummer softening:
+\[
+\Phi_i = -G \sum_{j \ne i} \frac{m_j}{\sqrt{\|\mathbf{r}_i-\mathbf{r}_j\|^2 + \varepsilon^2}},
+\qquad
+\mathbf{a}_i = -\nabla \Phi_i
+\]
+
+## Quadtree/Octree Split (Mermaid)
+
+```mermaid
+graph TD
+  R[Root Cell]
+  R --> C1[Child 1]
+  R --> C2[Child 2]
+  R --> C3[Child 3]
+  R --> C4[Child 4]
+```
+
 ## Center of Mass Calculation
 
 For each tree node, the center of mass and total mass are computed:

scripts/preview_docs.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -euo pipefail
+pip install mkdocs-material mkdocstrings[python] mkdocs-jupyter
+mkdocs serve -a 0.0.0.0:8000