Added Getting started section to readme.

master
pbrod 9 years ago
parent 2c90a05f80
commit 10f942aea7

@ -44,6 +44,9 @@ install:
# - conda build conda_recipe # - conda build conda_recipe
# - conda install wafo --use-local # - conda install wafo --use-local
before_script: 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.email "per.andreas.brodtkorb@gmail.com"
- git config --global user.name "pbrod" - git config --global user.name "pbrod"
script: script:

@ -95,6 +95,35 @@ And install the wheel package with::
pip install dist/wafo-X.Y.Z+abcd123-os_platform.whl 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 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 .. |depsy_img| image:: http://depsy.org/api/package/pypi/wafo/badge.svg
:target: http://depsy.org/package/python/wafo :target: http://depsy.org/package/python/wafo

@ -76,6 +76,7 @@ addopts =
norecursedirs = norecursedirs =
.* .*
_build _build
doc
docs docs
tmp* tmp*
source source

Loading…
Cancel
Save