From 9284850f46725bc8f629249e70cf271f5bacca05 Mon Sep 17 00:00:00 2001 From: saudzahirr Date: Mon, 30 Mar 2026 17:07:30 +0500 Subject: [PATCH] Refactor documentation formatting and improve installation instructions --- .github/dependabot.yml | 6 ------ docs/index.md | 10 ---------- docs/installation.md | 18 +++++++++--------- docs/quickstart.md | 20 ++++++++++---------- 4 files changed, 19 insertions(+), 35 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 7e6c742..6a61862 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,9 +6,3 @@ updates: schedule: interval: "weekly" day: "friday" - - - package-ecosystem: "uv" - directory: "/" - schedule: - interval: "weekly" - day: "friday" diff --git a/docs/index.md b/docs/index.md index 8b9c309..853e0b2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -28,16 +28,6 @@ $$ where $W(t)$ is a [Wiener process](https://en.wikipedia.org/wiki/Wiener_process) (standard Brownian motion). -## Why sdepack? - -| Feature | Detail | -|---|---| -| **Performance** | Compiled Fortran core — no Python loops in the hot path | -| **Reproducibility** | Deterministic seeded RNG (Park-Miller LCG with Schrage's overflow protection) | -| **Range of solvers** | Orders 1–4, covering both time-invariant and time-variant SDEs | -| **Simplicity** | One function call per solve; solutions land in a pre-allocated NumPy array | -| **Portability** | Linux, macOS, Windows; Python 3.10–3.14 | - ## Mathematical model Within the solvers, the SDE is parameterized as: diff --git a/docs/installation.md b/docs/installation.md index 227bf6d..7b9589a 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -101,18 +101,18 @@ This invokes the `meson` build system to compile the Fortran sources via Source builds require a working Fortran compiler. On most Linux distributions install `gfortran`: - ```bash - # Debian/Ubuntu - sudo apt install gfortran +```bash +# Debian/Ubuntu +sudo apt install gfortran - # Fedora - sudo dnf install gcc-gfortran +# Fedora +sudo dnf install gcc-gfortran - # macOS (Homebrew) - brew install gcc - ``` +# macOS (Homebrew) +brew install gcc +``` - On Windows, install MinGW-w64 with gfortran or use MSYS2. +On Windows, install MinGW-w64 with gfortran or use MSYS2. ## Verifying the installation diff --git a/docs/quickstart.md b/docs/quickstart.md index 77c70ad..0ee8abd 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -264,16 +264,16 @@ mean 0 and variance $\sigma^2/(2\theta) = 0.125$. !!! tip "Plotting trajectories" Use `matplotlib` with the time grid for visualization: - ```python - import matplotlib.pyplot as plt - - t = np.linspace(0.0, tn, N + 1) - plt.plot(t, x) - plt.xlabel("Time") - plt.ylabel("X(t)") - plt.title("SDE trajectory") - plt.show() - ``` +```python +import matplotlib.pyplot as plt + +t = np.linspace(0.0, tn, N + 1) +plt.plot(t, x) +plt.xlabel("Time") +plt.ylabel("X(t)") +plt.title("SDE trajectory") +plt.show() +``` !!! tip "Seed selection" The seed must be a positive integer. Different seeds produce entirely