NatLabRockies / NatLabRockies/H2Integrate

Finance Model Naming

Open
#331 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

finance
Dominant language
Python
Stars
26
Forks
44
Avg merge
3d 22h
Merged PRs (30d)
16

Description

Finance Model Names

It's potentially limiting to use the output metric in the name of the financial model.

Proposed solution

Consider using:

"Price-setter" for models where you provide the sell price of a commodity

and

"Price-taker" for models where you calculate the breakeven price of a commodity

These names would be more generalized.

Proposed by @jaredthomas68 in #310:
I think this is a good time to consider renaming the finance models perhaps changing ProFastComp to ProFastLCOP or opting for more generic names where the financial metrics that we are expecting out such as NPV or LCOE can be adjusted, depending on our inputs. Another approach might be to specify whether we are using a price taker or a price setter approach because many of the same metrics could be calculated but may have slightly different meanings. In this case we might instead of ProFastComp have ProFastPriceSetter or just ProFastFinance where the inputs indicate whether we are using a price setter or a price taker approach. I leaned towards the last option for simplicity, allowing the user to provide inputs, indicating whether or not we should use a price sitter or a price taker approach. The difference in our call to profast is minimal for us, and we can keep the user options simple.

Alternatives considered

Additional context

This would require multiple file changes and should be handled in a separate PR from #310. Related issues: #223.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing ProFastComp finance model and the discussion in issues #310 and #223. Map the model names and ProFast call sites across the repository, then define the chosen naming approach and update all affected files consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
fintech-quant
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.