Skip to main content

# Risk Analysis Virtual Environment ([RAVEN](https://inl.gov/raven/))

<img src=”./doc/misc/RD100_2023_Winner_Logo.png” align=”right” style=”margin-left: 20px; margin-bottom: 10px; width: 118px; height: 150px;”/>

<img src=”./doc/misc/RAVEN_Logo.png” alt=”RAVEN Logo” align=”right” style=”margin-left: 20px; margin-bottom: 10px; width: 203px; height: 150px;” width=”203” height=”150”>

[RAVEN](https://inl.gov/raven/) is designed to perform parametric and probabilistic analysis based on the response of complex system codes. RAVEN is capable of investigating the system response as well as the input space using Monte Carlo, Grid, or Latin Hyper Cube sampling schemes, but its strength is focused toward system feature discovery, such as limit surfaces, separating regions of the input space leading to system failure, using dynamic supervised learning techniques. RAVEN includes the following major capabilities:

  • Sampling of codes for uncertainty quantification and reliability analyses

  • Generation and use of reduced-order models (also known as surrogate)

  • Data post-processing (time dependent and steady state)

  • Time dependent and steady state, statistical estimation and sensitivity analysis (mean, variance, sensitivity coefficients, etc.).

The RAVEN statistical analysis framework can be employed for several types of applications:

  • Uncertainty Quantification

  • Sensitivity Analysis / Regression Analysis

  • Probabilistic Risk and Reliability Analysis (PRA)

  • Data Mining Analysis

  • Model Optimization

RAVEN provides a set of basic and advanced capabilities that ranges from data generation, data processing and data visualization. More information can be found at [RAVEN Wiki](https://github.com/idaholab/raven/wiki).

## Computing environment

  • Parallel computation capabilities (multi-thread and multi-core)

  • Supported operating systems: MAC, Linux and Windows

  • Workstation and high performance computing (HPC) systems

## Forward propagation of uncertainties

  • MonteCarlo sampling

  • Grid sampling

  • Stratified Sampling

  • Factorial design

  • Response surface design

  • Generalized Polynomial Chaos (gPC) with sparse grid collocation (SGC)

  • Generalized Polynomial Chaos (gPC) with sparse grid collocation (SGC) using the High Dimensional Model Representation expansion (HDMR)

  • General combination of the above sampling strategies

## Advance sampling methods

  • Moment driven adaptive gPC using SGC

  • Sobol index driven HDMR integrated using SGC over gPC basis

  • Adaptive sampling for limit surface finding (surrogate and multi grid based accelerations)

  • Dynamic event tree-based sampling (Dynamic Event Trees, Hybrid Dynamic Event Trees, Adaptive Dynamic Event Trees, Adaptive Hybrid Dynamic Event Trees)

## Creation and use of reduced order models

  • Support Vector Machine-based surrogates

  • Gaussian process models

  • Linear models

  • Multi-class classifiers

  • Decision trees

  • Naive Bayes

  • Neighbors classifiers and regressors

  • Multi-dimensional interpolators

  • High dimension model reduction (HDMR)

  • Morse-Smale complex

## Model capabilities

## Data Post-Processing capabilities

  • Data clustering

  • Data regression

  • Data dimensionality Reduction

  • Custom generic post-processors

  • Time-dependent data analysis - Statistics, sensitivity and uncertainty analysis - Clustering/classification - Time series analysis, such as ARMA, AutoARMA, MarkovAR, RWD, STL, Wavelet, VARMA, and Fourier.

  • Data plotting

## Model parameter optimization

  • Gradient-based approach

  • Simultaneous perturbation stochastic approximation method

  • Bayesian optimization

  • Genetic algorithms including single and multi-objective optimization

## Data management

  • Data importing and exporting

  • Databases creation

More information on this project is available at the [RAVEN website](https://raven.inl.gov/SitePages/Overview.aspx).

This project is supported by [Idaho National Laboratory](https://www.inl.gov/).

## Official Plugins The following plugin repositories are officially supported by RAVEN. ### Openly Available These plugin repositories are available without restriction to RAVEN users: - [TEAL](https://github.com/idaholab/TEAL) module: provides economic analysis. - [HERON](https://www.github.com/idaholab/HERON) module: provides workflow generation and dispatching models for performing stochastic technoeconomic analysis of systems of components interconnected by the resources they produce and consume. - [SR2ML](https://github.com/idaholab/SR2ML) module: provides safety, risk and reliability analysis tools. - [LOGOS](https://github.com/idaholab/LOGOS) module: provides computational capabilities to optimize plant resources such as maintenance optimization and optimal component replacement schedule by using state-of-the-art discrete optimization methods. - [FARM](https://github.com/Argonne-National-Laboratory/FARM) module: is designed to solve the supervisory control problem in Integrated Energy System (IES) project. FARM utilizes the linear state-space representation (A,B,C matrices) of a model to predict the system state and output in the future time steps, and adjust the actuation variable to avoid the violation of implicit thermal mechanical constraints. - [BayCal](https://github.com/idaholab/BayCal) module: is aiming at inversely quantifying the uncertainties associated with simulation model parameters based on available experiment data. BayCal tries to resolve two critical issues existing in the Bayesian inference: 1) high-dimensional experimental data (such as time series observations at multiple locations), 2) expensive computational simulations. These issues have been studied and resolved in literature, but there is not yet a complete toolkit to resolve these issues in an efficient and automatic way. BayCal automatizes the process by coupling with RAVEN, utilizes artificial intelligence algorithms to automatically construct surrogate models for the expensive computational simulations and dimensionality reduction techniques to significantly reduce the number of simulations for convergence. - [POEM](https://idaholab.github.io/POEM/) module: is a platform for optimal experiment management, powered with automated machine learning to accelerate the discovery of optimal solutions, and automatically guide the design of experiments to be evaluated. POEM currently supports 1) random model explorations for experiment design, 2) sparse grid model explorations with Gaussian Polynomial Chaos surrogate model to accelerate experiment design ,3) time-dependent model sensitivity and uncertainty analysis to identify the importance features for experiment design, 4) model calibrations via Bayesian inference to integrate experiments to improve model performance, and 5) Bayesian optimization for optimal experimental design. In addition, POEM aims to simplify the process of experimental design for users, enabling them to analyze the data with minimal human intervention, and improving the technological output from research activities. POEM leverages RAVEN (a robust platform to support model explorations and decision making) to allow for large scalability and reduction of the computational costs and provides access to complex physical models while performing optimal experimental design. - [DOVE](https://github.com/idaholab/DOVE) module: The Dispatch Optimization Variable Engine (DOVE) is software tool written in python, developed at Idaho National Laboratory that provides an easily accessible API to performing dispatch analysis for integrated energy system configurations.

### Other Software [Idaho National Laboratory](https://www.inl.gov/) is a cutting edge research facility which is a constantly producing high quality research and software. Feel free to take a look at our other software and scientific offerings at:

[Primary Technology Offerings Page](https://www.inl.gov/inl-initiatives/technology-deployment)

[Supported Open Source Software](https://github.com/idaholab)

[Raw Experiment Open Source Software](https://github.com/IdahoLabResearch)

[Unsupported Open Source Software](https://github.com/IdahoLabCuttingBoard)

### License

Files in crow/contrib, src/contrib and framework/contrib are third party libraries that are not part of Raven and are provided here for covenience. These are under their own, seperate licensing which is described in those directories.

Raven itself is licensed as follows:

Copyright 2016 Battelle Energy Alliance, LLC

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Metadata

Release files for raven-framework 3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for raven-framework 3.3
File Size Uploaded Provenance
raven_framework-3.3.tar.gz 3.2 MB Without provenance Details

Built distributions (wheels)

Table of built distributions (wheels) for raven-framework 3.3
File
raven_framework-3.3-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details
raven_framework-3.3-cp311-cp311-macosx_11_0_arm64.whl CPython 3.11 CPython 3.11 macOS 11.0+ ARM64 Details
raven_framework-3.3-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details
raven_framework-3.3-cp310-cp310-macosx_11_0_arm64.whl CPython 3.10 CPython 3.10 macOS 11.0+ ARM64 Details

Total release size: 13.9 MB

Release files / raven_framework-3.3.tar.gz

Download URL raven_framework-3.3.tar.gz
Size 3.2 MB
Tags Source
SHA-256 checksum
How to use checksums
fcad8ea2d2dc028d23d9eeb59bc2e3c78da2d83a589f7bd0426d427487ae7491
BLAKE2b-256 checksum
How to use checksums
62114ebc28738c08899f254994a5ec702a33d3f569cb82f43bfd1349bc28e459
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.2

Release files / raven_framework-3.3-cp311-cp311-win_amd64.whl

Download URL raven_framework-3.3-cp311-cp311-win_amd64.whl
Size 2.7 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
d622fb48a7e91f737e1e909c2331e02799782805da7f08b2fdf28dd4a280c600
BLAKE2b-256 checksum
How to use checksums
028f61a9372998359d0361f42af2be80d28ce42a5fba2faeee40f8007e690688
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.2

Release files / raven_framework-3.3-cp311-cp311-macosx_11_0_arm64.whl

Download URL raven_framework-3.3-cp311-cp311-macosx_11_0_arm64.whl
Size 2.7 MB
Tags CPython 3.11 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
a3546280820a247574f3a1e1dd2b60395228dc6b05b46ba90550e4fdb59bc5b0
BLAKE2b-256 checksum
How to use checksums
bb80020b3bfd31fc9cd9d38c32258e2355e8258852e3223ce904e0b140344c4f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.2

Release files / raven_framework-3.3-cp310-cp310-win_amd64.whl

Download URL raven_framework-3.3-cp310-cp310-win_amd64.whl
Size 2.7 MB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
74f892a0a6907cea1ab9e02bc83fdfc45ae5c91755b361bbc743f77a3c5ef379
BLAKE2b-256 checksum
How to use checksums
b31fb86207b93dde96cfac1c88d49c6001c246cc5a041ad1e6738eab9562bfa3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.2

Release files / raven_framework-3.3-cp310-cp310-macosx_11_0_arm64.whl

Download URL raven_framework-3.3-cp310-cp310-macosx_11_0_arm64.whl
Size 2.7 MB
Tags CPython 3.10 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
3fdd6af2545874d87ed883573312907234632715595e7302258814f014134cb5
BLAKE2b-256 checksum
How to use checksums
2bcd39b6022bc38350b9b1db0fde5ee12701f33f8428071e99e43f2bd01255d5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.2

Security for raven-framework 3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page