User Guide

Warning

We are currently working on virocon’s documentation for version 2. Only a part of the functionality is described properly until now. In the meantime if you have any questions feel free to open an issue.

• Installation
  • Requirements
  • Install
• Quick start example: Sea state contour
• Overall work flow and software architecture
• Environmental contour: useful definitions
• Detailed examples
  • 50 year environmental contour: Hs-Tz DNVGL model
  • 50 year environmental contour: V-Hs-Tz
• Defining custom joint models and estimating their parameters
  • Creating a global hierarchical model
  • Implementing a new univariate distribution
• Constructing different types of contours
• Cheat sheet for the “description” data structures
  • dist_descriptions
  • fit_descriptions
  • semantics

Note

This user guide describes the newest version of virocon. Version 2.0 of virocon was a major update such that code from versions 1.X does not work with virocon 2.X. The old user guide for version 1 can be downloaded here.