-
Notifications
You must be signed in to change notification settings - Fork 21
Home
Welcome to the wiki page of CashFlow. CashFlow is a plugin for the RAVEN code.
The plugin enables the capability to compute the NPV (Net Present Value), the IRR (Internal Rate of Return) and the PI (Profitability Index) with RAVEN. Furthermore, it is possible to do an NPV, IRR or PI search, i.e. CashFlow will compute a multiplicative value (for example the production cost) so that the NPV, IRR or PI has a desired value. The plugin allows for a generic definition of cash flows which drivers are provided by RAVEN. Furthermore, CashFlow includes flexible options to deal with taxes, inflation, discounting and offers capabilities to compute a combined cash flow for components with different component lives.
The CashFlow plugin is distributed with RAVEN. If you just want to use the plugin and are not interested in developing additional features or bug-fixes for it, just make sure that you have access to the plugin repository and you will automatically get it when installing RAVEN. Please contact the Plugin owner to request access to the CashFlow plugin.
Once you have access to the plugin, help for connecting to the plugin repository can be found here: HPC GitLab Connectivity (official INL HPC page)
All the plugin manuals that are available in RAVEN are compiled into one 'plugin manual' during the RAVEN installation. See RAVEN documentation for more information.
If you want to compile the CashFlow manual as a stand alone pdf, run
cd ~/raven/plugins/CashFlow/doc
make
To help develop CashFow, one first needs to download and install the RAVEN code. RAVEN can be downloaded from Github. Installation instruction instructions are also available.
RAVEN installation instructions
RAVEN plugin installation for development
The CashFlow plugin can be downloaded from the INL GitLab repository. Help for connecting to the INL GitLab servers is also available.
HPC GitLab Connectivity (official INL HPC page)
The development of CashFlow follows the same quality standards as RAVEN. Detailed information on the development workflow can be found here.
Summaries of the most important guidelines can be found in the following links:
[Regression Test Framework] (simpletest)
[PYTHON code standards](Python Code Standards)