Skip to content

docs: refresh README with a quickstart and current feature overview - #69

Open
dylanjm wants to merge 2 commits into
mainfrom
docs/readme-refresh
Open

dylanjm wants to merge 2 commits into
mainfrom
docs/readme-refresh

Conversation

@dylanjm

@dylanjm dylanjm commented Oct 28, 2026

Copy link
Copy Markdown
Collaborator

Closes #68

Summary

  • Positioning: describes DCAF as a library for capital-intensive energy projects, and notes that it was first built at INL to evaluate nuclear power uprates.
  • Installation: leads with pip install dcaf-idaholab, with uv add as the alternative.
  • Getting Started: a single runnable example (220 MW plant, S-curve construction spending, 50% debt, PPA-style revenue, opex, PTC, MACRS) that prints NPV, IRR, and LCOE and writes an annual pro forma to CSV.
  • Overview: rewritten to cover the current feature set: the builder, metrics and pro formas, construction and financing, contract pricing and outages, tax and incentives, and the lower-level primitives.
  • Removed the Day Count Conventions section, since the docs already cover it (docs/concepts/conventions.md).
  • Test: tests/test_documented_outputs.py now runs the README example and compares its printed output with the documented text block, so the numbers can't drift silently.

Links use full GitHub URLs because pyproject.toml uses the README as the PyPI page. The Documentation link can point to the Pages site once #67 is live.

Test plan

  • pytest tests/test_documented_outputs.py: 7 passed. The new test fails if a documented README value is changed.
  • Full suite: 1046 passed
  • pre-commit run --all-files passes

🤖 Generated with Claude Code

dylanjm and others added 2 commits October 28, 2026 14:15
Positions DCAF as a library for capital-intensive energy projects, with
nuclear uprates as its origin. Recommends pip first, adds a runnable Getting
Started example, updates the Overview to the current feature set, and drops
the Day Count Conventions section in favor of the docs.

Co-Authored-By: Claude <noreply@anthropic.com>
… output

Runs the root README's python example and compares its printed output with
the text block that follows it.

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refresh README: quickstart, current features, broader positioning

1 participant