Relevant Issues and Features - From RAVEN v2.0 to v2.1

[alfoa]

---

Issue Description

This issue is a floating tracking system for recording all the main defects and features addressed from a release to the other.
Base Release: RAVEN v.2.0
Next Release: RAVEN v.2.1

Addressed Defects:

• []

New Features:

• Added HERON as a supported plugin for those with access to it. HERON (Holistic Energy Resource Optimization Network) is a plugin for stochastic technoeconomic analysis of connected systems with resource usage.

• Implemented a new model entity "LogicalModel". The LogicalModel utilizes control functions to manage the selection and execution of different models (i.e. ExternalModel, ROMs, Codes). Both LogicalModel and current HybridModel share some common functionalities. In this case, a new base class is created for both entities.

• Add implicit function constrains in the optimizer and the reject reason flag on the new optimal point.

• Implementation of Markov Chain Monte Carlo algorithm, i.e. Metropolis Algorithm. Markov Chain Monte Carlo (MCMC) is mainly used for Bayesian Calibration (or inverse uncertainty quantification). It can also be used to sample any given distribution.

• Extended restart capability to Adaptive Samplers, including passing through FinalizeActualSampling.

• Extended CSV readers for Codes to be consistent with DataSet reading. This allows reading CSVs with string entries from Codes. Also retained a float-only option for CodeInterfaces with large output CSVs without useful string entries.

• Added a profiling mode for developers for checking bottlenecks through a --profile argument to raven_framework. Requires installation of optional library line_profiler.

• Added a new Post Processor EconomicRatio, for calculating the return of an investment compared to its risk, several metrics are implemented such as Sharpe ratio, Sortino ratio, gain-loss ratio, value at risk, and conditional value at risk.

Submodules (i.e. plugins) updates:

• Add CI for plugins LOGOS, SRAW and SR2ML;
• Add maintenance models for SR2ML;
• Updated HERON to SQA, open source version
• CashFlow renamed to TEAL and open sourced

Features' issues' tracking IDs:

• Heron submod #1236, HERON plugin #1271 : HERON as a submod (SQA)
• Sync HERON and TEAL #1298 HERON, RAVEN, TEAL open source and synced
• [TASK] Restructure HybridModel class  #1202 Restructure HybridModel and add LogicalModel
• update submodule IDs of LOGOS, SRAW, and SR2ML #1245 Update plugins: LOGOS, SR2ML, and SRAW
• [TASK] uniform discrete distribution #1249 Creation of the uniform discrete distribution which allows the user to perform sampling (with and without replacement) from a discrete set of values
• [TASK] implicit constraint in optimizer. Rejection. #1223 Handle implicit constrain from user, adding a simple feature for rejection and acceptance for the implicit constrain, and the optimal point rejects reason with no improvement or rejected by implicit constrains.
• [TASK] Markov Chain Monte Carlo: Metropolis Algorithm #1260 Implementation of Markov Chain Monte Carlo algorithm, i.e. Metropolis Algorithm.
• Csv loader pandas #1267 Adding string-csv reading for Code models.
• Extend Restart to Adaptive samplers #1283 Restarts extended to AdaptiveSamplers
• Enabling profiling in RAVEN #1318 Enabling profiling in RAVEN
• Finance metrics and median calculation #1289 Financial metric PostProcesor

---

For Change Control Board: Issue Review

This review should occur before any development is performed as a response to this issue.

• 1. Is it tagged with the under_discussion type?
• 2. If implemented, it will add a new requirement?
• 3. Is a rationale provided? (Such as explaining why the improvement is needed )

---

For Change Control Board: Issue Closure

This review should occur when the issue is imminently going to be closed.

• 1. The discussion determined the addition of a new task issue?

[wangcj05]

We have released RAVENv2.1, and this issue can be closed.