ViroCon's numerical core: computes n-dimensional environmental contours
Project description
ViroCon is a software to compute environmental contours.
About
viroconcom is a package belonging to the software ViroCon. The package viroconcom handles the statistical computations.
ViroCon helps you to design marine structures, which need to withstand load combinations based on wave, wind and current. It lets you define extreme environmental conditions with a given return period using the environmental contour method.
The following methods are implemented in viroconcom:
Fitting a probabilistic model to measurement data using maximum likelihood estimation
Defining a probabilistic model with the conditonal modeling approach (CMA)
Computing an environmental contour using either the
inverse first-order reliability method (IFORM),
inverse second-order reliability method (ISORM) or the
highest density contour (HDC) method
ViroCon is written in Python 3.6.4. The software is seperated in two main packages, viroconweb and viroconcom. This is the repository of viroconcom, which is the numerical core. It handles the statistical computations. viroconweb builds on viroconcom and is a web-based application with a graphical user interface. It has its own repository.
How to use viroconcom
Requirements
Make sure you have installed Python 3.7.4 by typing
python --version
in your shell.
Consider using the python version management pyenv.
Install
Install the latest version of viroconcom from PyPI by typing
pip install viroconcom
in your shell.
Alternatively, you can install from viroconcom repository’s Master branch by typing
pip install https://github.com/virocon-organization/viroconcom/archive/master.zip
in your shell.
Usage
viroconcom is designed as an importable package.
The documentation gives examples how to fit a distribution to measurement data and how to compute environmental contours.
Additionally, the folder examples contains python files that show how one can import and use viroconcom.
As an example, to run the file calculate_contours_similar_to_docs.py, use your shell to navigate to the folder that contains the file. Then make sure that you have installed the python package matplotlib or install it by typing
pip install matplotlib
in your shell.
Now run the Python file by typing
python calculate_contours_similar_to_docs.py
in your shell.
Documentation
Code. The code’s documentation can be found here.
Paper. Our SoftwareX paper “ViroCon: A software to compute multivariate extremes using the environmental contour method.” provides a concise description of the software.
Contributing
There are various ways you can contribute. You could
improve the code,
improve the documentation,
add a feature or
report a bug or an improvement and leave it to us to implement it.
Issue. If you spotted a bug, have an idea for an improvement or a new feature, please open a issue. Please open an issue in both cases: If you want to work on in yourself and if you want to leave it to us to work on it.
Fork. If you want to work on an issue yourself please fork the repository, then develop the feature in your copy of the repository and finally file a pull request to merge it into our repository.
Conventions. In our Contribution Guide we summarize our conventions, which are consistent with PEP8.
Cite
If you are using viroconcom in your academic work please cite it by referencing our SoftwareX paper.
Example: Environmental contours were computed using the package viroconcom (version 1.2.0) of the software ViroCon [1].
[1] A.F. Haselsteiner, J. Lemkuhl, T. Pape, K.-L. Windmeier, K.-D. Thoben: ViroCon: A software to compute multivariate extremes using the environmental contour method. Accepted by SoftwareX.
License
This software is licensed under the MIT license. For more information, read the file LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.