Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

73 lines (54 loc) · 2.21 KB

Contributing to Aethermor

Thanks for contributing.

Ground Rules

  • All physics must use SI units (Joules, Kelvin, Watts, metres).
  • Every public claim must map to the claim/evidence ledger.
  • Keep changes minimal, explicit, and test-backed.
  • Do not introduce unverifiable benchmark claims.

High-Value Contributions

The most valuable contributions extend the physics foundation:

  • New materials: Register via registry.register("my_mat", Material(...)) with published property values and source citations
  • New computing paradigms: Implement the EnergyModel protocol (energy_per_switch() + landauer_gap()) and register via paradigm_registry.register("my_paradigm", MyModelClass)
  • New cooling layers: Register via cooling_registry.register("my_tim", ThermalLayer(...))
  • Material provenance: Add verified per-property sources, conditions, orientation/grade, and uncertainty
  • Interconnect power models: Wire dissipation as a function of technology node
  • Additional validation checks: Add to aethermor/validation/engineering.py with reference source citations

All contributions must include tests in tests/ and, for physics, a corresponding validation check with a cited reference.

Development Setup

git clone https://github.com/Yoder23/aethermor.git
cd aethermor
python -m pip install -e ".[dev]"

Run tests:

python -m pytest -q
aethermor validate --json

Run examples:

aethermor demo --samples 30
python -m examples.steady_power_map
python -m examples.maximum_power

Pull Request Requirements

  • Include a clear problem statement.
  • Include test evidence (pytest output).
  • If adding physics, include validation checks with reference citations.
  • If touching existing models, verify the analytical and mesh-convergence gates.
  • Never call repository-authored verification independent validation.

Style Expectations

  • Python code should remain readable and explicit.
  • Use type hints for public API functions.
  • Prefer dataclasses for data containers.
  • Follow PEP 8 naming conventions.

Commit and PR Scope

  • One concern per PR when possible.
  • Separate refactors from behavioral changes.
  • Do not include generated artifact directories.