We stopped maintaining viroconweb to concentrate on viroconcom.
ViroCon is a software to compute environmental contours.
viroconweb is a package belonging to the software ViroCon. Using the web framework Django it provides a browser-based graphical user interface.
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 available in viroconweb (additonal methods are available 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) 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 viroconweb, which is a web application written with the web framework Django 1.11. The second package, viroconcom, handles the statistical computations and has its own repository.
Make sure you have installed
- Python 3.6.4 (even Python 3.5 won't work; consider using the python version management pyenv)
- git and
- LaTeX.
To run a copy of ViroCon locally fist clone the repository by typing
git clone https://github.com/virocon-organization/viroconweb
in your shell.
Then install all required python packages and prepare the web-application. Type
cd viroconweb
pip install -r requirements.txt
python manage.py collectstatic
python manage.py migrate
in your shell.
Now everything should be set up and you can run a local copy by running manage.py and using 'runserver' as the argument. Type
python manage.py runserver
in your shell. You should reach a local version of ViroCon at http://localhost:8000
If you don't want to work with viroconweb's graphical userer interface, but want to compute environmental contours with Python, use the package we built for the needed statistical computations, viroconcom.
Code. The code's documentation can be found here.
Methods. The app has a help page, which describes the implemented methods in detail. If you runt he app it can be found at http://localhost:8000/info/help. Its template is located here.
Paper. Our SoftwareX paper "ViroCon: A software to compute multivariate extremes using the environmental contour method." provides a concise description of the software.
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.
If you are using viroconweb in your academic work please cite it by referencing our SoftwareX paper.
Example long: Environmental contours were computed using the package viroconweb of the software ViroCon (viroconweb version 1.0.8, viroconcom version 1.2.0) [1].
Example short: Environmental contours were computed using 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.
This software is licensed under the MIT license. For more information, read the file LICENSE.