Installation & Usage & Methodology

Installation & Usage & Methodology#

The Golden Rule:

Use Standard Tools

Stick to standard, modern tools

  • Use language-standard packaging systems (pyproject.toml)

  • Minimize custom installation steps

  • Document environment setup explicitly

Example: Python-based project using uv.

git clone https://github.com/<owner>/<repo-name>.git
cd repo-name
uv sync

Key points:

  • uv sync uses the Python version from pyproject.toml

  • Creates isolated .venv automatically

  • Installs all dependencies and project in editable mode

Minimal, copy-pasteable example:

uv run python scripts/drafts/hello.py

import numpy as np
from mypkgs.math import multiply_matrices

a = np.array([[1,2],[3,4]])
b = np.array([[4,3],[2,1]])
multiply_matrices(a,b)
# Out[5]: array([[8, 5], [20, 13]])

Keep the technical overview high-level:

  • List core algorithms and computational workflows

  • Example: “Uses CNN and Runge-Kutta integration”

Details belong in extended documentation.