Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
# DCAF

The Discounted Cashfow Analysis Framework is a
professional financial engineering library for nuclear energy project cost and
metric calculations, with a focus on Extended Power Uprate (EPU) projects.
The Discounted Cash Flow Analysis Framework is a professional financial engineering
library for nuclear energy project cost and metric calculations, with a focus on
Extended Power Uprate (EPU) projects.

## Installation

Install the `dcaf-idaholab` distribution from PyPI:

```bash
uv add dcaf-idaholab
# or: pip install dcaf-idaholab
```

The Python import package remains `dcaf`:

```python
from dcaf import EnergyProject
```

## Overview

DCAF provides high-fidelity cost modeling and financial analyis tools
specifcally designed for nuclear energy projects. The library enables detailed
DCAF provides high-fidelity cost modeling and financial analysis tools
specifically designed for nuclear energy projects. The library enables detailed
financial analysis including:

- Net Present Value (NPV), Discounted Cashflow (DCF) and Internal Rate of Return
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ it with `uv run` (e.g. `uv run python`), or activate `.venv` directly.
Once DCAF is published as a package, you can instead add it to your own project:

```bash
uv add dcaf # or: pip install dcaf
uv add dcaf-idaholab # or: pip install dcaf-idaholab
```

## 2. Build and analyze a project
Expand Down
39 changes: 38 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,53 @@ requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "dcaf"
name = "dcaf-idaholab"
version = "0.1.0"
description = "Discounted Cashflow Analysis Framework is a financial engineering library for nuclear energy projects."
readme = "README.md"
requires-python = ">=3.11"
license = "MIT"
authors = [
{name = "Dylan J. McDowell"},
{name = "Jacob A Bryan"},
{name = "Caleb M Sitton"},
{name = "Gabriel J Soto Gonzalez"},
{name = "Nahuel Guaita"},
{name = "Paul W Talbot"},
]
maintainers = [
{name = "Idaho National Laboratory"},
]
keywords = [
"discounted cash flow",
"financial engineering",
"nuclear energy",
"techno-economic analysis",
"extended power uprate",
]
classifiers = [
"Development Status :: 4 - Beta",
"Intended Audience :: Science/Research",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Topic :: Office/Business :: Financial",
"Topic :: Scientific/Engineering",
]
dependencies = [
"python-dateutil>=2.9.0.post0",
"types-python-dateutil>=2.9.0.20260302",
]

[project.urls]
Homepage = "https://github.com/IdahoLabResearch/DCAF"
Documentation = "https://github.com/IdahoLabResearch/DCAF/tree/main/docs"
Repository = "https://github.com/IdahoLabResearch/DCAF.git"
Issues = "https://github.com/IdahoLabResearch/DCAF/issues"

[tool.hatch.build.targets.wheel]
packages = ["dcaf"]


[dependency-groups]
all = [
Expand Down
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.