Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
update readme for virocon v2
  • Loading branch information
kawindme committed May 21, 2021
1 parent ecffebc commit fd7fcc2
Showing 1 changed file with 16 additions and 42 deletions.
58 changes: 16 additions & 42 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
ViroCon: viroconcom
===================
virocon
=======

.. image:: https://travis-ci.org/virocon-organization/viroconcom.svg?branch=master
:target: https://travis-ci.org/virocon-organization/viroconcom
Expand All @@ -8,19 +8,17 @@ ViroCon: viroconcom
.. image:: https://coveralls.io/repos/github/virocon-organization/viroconcom/badge.svg?branch=master
:target: https://coveralls.io/github/virocon-organization/viroconcom?branch=master

ViroCon is a software to compute environmental contours. `User Guide`_
virocon is a software to compute environmental contours. `User Guide`_

About
-----

viroconcom is a Python software package to compute environmental contours.

The software can support you to design marine structures, which need to withstand
virocon can support 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:
The following methods are implemented in virocon:

- Defining a joint probability distributions using a global hierarchical model structure
- Estimating the parameters of a global hierarchical model ("Fitting")
Expand All @@ -31,11 +29,11 @@ The following methods are implemented in viroconcom:
- the direct sampling contour method or the
- highest density contour method.

How to use viroconcom
---------------------
How to use virocon
------------------
Requirements
~~~~~~~~~~~~
Make sure you have installed Python `3.8` by typing
Make sure you have installed Python `3.9` by typing

.. code:: console
Expand All @@ -45,19 +43,16 @@ in your `shell`_.

(Older version might work, but are not actively tested)

Consider using the python version management `pyenv`_.


Install
~~~~~~~
Install the latest version of viroconcom from PyPI by typing
Install the latest version of virocon from PyPI by typing

.. code:: console
pip install viroconcom
pip install virocon
Alternatively, you can install from viroconcom repository’s Master branch
Alternatively, you can install from virocon repository’s Master branch
by typing

.. code:: console
Expand All @@ -68,10 +63,10 @@ by typing
Usage
~~~~~

viroconcom is designed as an importable package.
virocon is designed as an importable package.

The folder `examples`_ contains python files that show how one can
import and use viroconcom.
import and use virocon.

As an example, to run the file `sea_state_iform_contour.py`_, use
your shell to navigate to the folder that contains the file. Make sure
Expand All @@ -81,13 +76,9 @@ that you have installed matplotlib and run the Python file by typing
python sea_state_iform_contour.py
Our documentation contains a user guide, with examples how to
`fit a distribution`_ to measurement data and how to
`compute environmental contours`_.

Documentation
-------------
**Learn.** Our `User Guide`_ covers installation, requirementss and overall work flow.
**Learn.** Our `User Guide`_ covers installation, requirements and overall work flow.

**Code.** The code’s documentation can be found `here`_.

Expand All @@ -100,27 +91,14 @@ Contributing

**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
you want to work on it 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.
**Conventions.** We use PEP8.

License
-------
Expand All @@ -131,13 +109,9 @@ read the file `LICENSE`_.
.. _User Guide: https://virocon-organization.github.io/viroconcom/user_guide.html
.. _viroconweb: https://github.com/virocon-organization/viroconweb
.. _shell: https://en.wikipedia.org/wiki/Command-line_interface#Modern_usage_as_an_operating_system_shell
.. _pyenv: https://github.com/pyenv/pyenv
.. _www.python.org: https://www.python.org
.. _fit a distribution: https://virocon-organization.github.io/viroconcom/fitting.html
.. _compute environmental contours: https://virocon-organization.github.io/viroconcom/jointdistribution_and_contours.html
.. _examples: https://github.com/virocon-organization/viroconcom/tree/master/examples
.. _sea_state_iform_contour.py: https://github.com/virocon-organization/viroconcom/blob/master/examples/sea_state_iform_contour.py
.. _here: https://virocon-organization.github.io/viroconcom/
.. _Contribution Guide: https://virocon-organization.github.io/viroconcom/contributionguide.html
.. _LICENSE: https://github.com/virocon-organization/viroconcom/blob/master/LICENSE
.. _SoftwareX paper: https://github.com/ahaselsteiner/publications/blob/master/2018-10-25_SoftwareX_ViroCon_revised.pdf

0 comments on commit fd7fcc2

Please sign in to comment.