From 10f942aea79e28765977b2c94bb3afac85891913 Mon Sep 17 00:00:00 2001 From: pbrod Date: Sun, 26 Jun 2016 18:50:08 +0200 Subject: [PATCH] Added Getting started section to readme. --- .travis.yml | 3 +++ README.rst | 31 ++++++++++++++++++++++++++++++- setup.cfg | 1 + 3 files changed, 34 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index ce8097d..c0deb51 100644 --- a/.travis.yml +++ b/.travis.yml @@ -44,6 +44,9 @@ install: # - conda build conda_recipe # - conda install wafo --use-local before_script: + - "export DISPLAY=:99.0" + - "sh -e /etc/init.d/xvfb start" + - sleep 3 # give xvfb some time to start - git config --global user.email "per.andreas.brodtkorb@gmail.com" - git config --global user.name "pbrod" script: diff --git a/README.rst b/README.rst index f872afc..9d1cb08 100644 --- a/README.rst +++ b/README.rst @@ -95,6 +95,35 @@ And install the wheel package with:: pip install dist/wafo-X.Y.Z+abcd123-os_platform.whl +Getting started +=============== + +A quick introduction to some of the many features of wafo can be found in the Tutorial IPython notebooks in the +_tutorial scripts folder: + + +* Chapter 1 - _Some applications of WAFO + +* Chapter 2 - _Modelling random loads and stochastic waves + +* Chapter 3 - _Demonstrates distributions of wave characteristics + +* Chapter 4 - _Fatigue load analysis and rain-flow cycles + +* Chapter 5 - _Extreme value analysis + +-- _tutorial scripts folder: http://nbviewer.jupyter.org/github/wafo-project/pywafo/tree/master/wafo/doc/tutorial_scripts/ + +.. _Some applications of WAFO: http://nbviewer.jupyter.org/github/wafo-project/pywafo/blob/master/wafo/doc/tutorial_scripts/WAFO%20Chapter%201.ipynb + +.. _Modelling random loads and stochastic waves: http://nbviewer.jupyter.org/github/wafo-project/pywafo/blob/master/wafo/doc/tutorial_scripts/WAFO%20Chapter%202.ipynb + +.. _Demonstrates distributions of wave characteristics: http://nbviewer.jupyter.org/github/wafo-project/pywafo/blob/master/wafo/doc/tutorial_scripts/WAFO%20Chapter%203.ipynb + +.. _Fatigue load analysis and rain-flow cycles: http://nbviewer.jupyter.org/github/wafo-project/pywafo/blob/master/wafo/doc/tutorial_scripts/WAFO%20Chapter%204.ipynb + +.. _Extreme value analysis: http://nbviewer.jupyter.org/github/wafo-project/pywafo/blob/master/wafo/doc/tutorial_scripts/WAFO%20Chapter%205.ipynb + Unit tests ========== @@ -137,4 +166,4 @@ information on PyScaffold see http://pyscaffold.readthedocs.org/. .. |depsy_img| image:: http://depsy.org/api/package/pypi/wafo/badge.svg - :target: http://depsy.org/package/python/wafo \ No newline at end of file + :target: http://depsy.org/package/python/wafo diff --git a/setup.cfg b/setup.cfg index 84c8c21..a21d774 100644 --- a/setup.cfg +++ b/setup.cfg @@ -76,6 +76,7 @@ addopts = norecursedirs = .* _build + doc docs tmp* source