Skip to content

Reliafy CLI Documentation

Reliafy CLI provides a command-line interface for reliability analysis, reliability-based design optimization, and simulation workflows with profile-based configuration.

The platform is implementation-focused: it exposes robust, well-documented methods without trying to replicate textbook-level theory inside the user docs. In practice, workflows center on First-Order Reliability Method (FORM), Inverse FORM, Monte Carlo simulation, and Importance Sampling, with Nataf transformation used where needed to handle correlated, non-normal random variables in a consistent reliability framework.

For second-order methods (SORM), this documentation keeps explanations concise and points to curated references in the SORM settings documentation: Profile Options Reference - SORM Settings.

  • Ang, A. H.-S., and Tang, W. H. (2007). Probability Concepts in Engineering: Emphasis on Applications to Civil and Environmental Engineering (2nd ed.). John Wiley and Sons.
  • Der Kiureghian, A. (2022). Structural and System Reliability. Cambridge University Press.

Software References

For third-party Python library citation guidance, see Software and Library References. That section now separates:

  • CLI dependencies users install in their environment
  • API dependencies documented for attribution/credit only

Quick Start

# Install the CLI from PyPI
pip install reliafy

# View available commands
python -m reliafy --help

# Copy example problems
python -m reliafy examples cp

# Run an analysis with the default profile
python -m reliafy analyze default --include-sorm --plot-rfad

Developer install

If you are working from a local clone of the source repository, use an editable install instead: 

pip install -e .
This links directly to your source folder so code changes take effect without reinstalling.

Main Commands

Analysis

Run reliability analysis using FORM, SORM, and Monte Carlo methods: 

python -m reliafy analyze <profile> [OPTIONS]

Design Optimization

Run reliability-based design optimization: 

python -m reliafy design <profile> [OPTIONS]

Simulation

Run Monte Carlo simulation with importance sampling: 

python -m reliafy simulate <profile> [OPTIONS]

Configuration

Reliafy CLI uses YAML profile files to configure analysis parameters. Create and manage profiles using:

# Create a new profile
python -m reliafy profile new myprofile

# Edit the profile
python -m reliafy profile nano myprofile

# List all profiles
python -m reliafy profile ls

See the Profiles page for detailed profile management commands and the Profile Options Reference for complete configuration options.

Authentication

Authenticate with the Reliafy API:

# Authenticate user
python -m reliafy user auth

# Check authentication status
python -m reliafy user id

See the Auth page for more details.

Requirements

  • Python 3.10+
  • Internet connection for API access and authentication
  • Valid Reliafy API credentials

Getting Help

All commands support the --help flag for detailed usage information:

python -m reliafy --help
python -m reliafy analyze --help
python -m reliafy profile --help