Thanks for contributing.
- 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.
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
EnergyModelprotocol (energy_per_switch()+landauer_gap()) and register viaparadigm_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.pywith reference source citations
All contributions must include tests in tests/ and, for physics, a
corresponding validation check with a cited reference.
git clone https://github.com/Yoder23/aethermor.git
cd aethermor
python -m pip install -e ".[dev]"Run tests:
python -m pytest -q
aethermor validate --jsonRun examples:
aethermor demo --samples 30
python -m examples.steady_power_map
python -m examples.maximum_power- Include a clear problem statement.
- Include test evidence (
pytestoutput). - 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.
- Python code should remain readable and explicit.
- Use type hints for public API functions.
- Prefer dataclasses for data containers.
- Follow PEP 8 naming conventions.
- One concern per PR when possible.
- Separate refactors from behavioral changes.
- Do not include generated artifact directories.