Skip to content

Commit

Permalink
working on the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Pelaez-Zapata committed Jul 5, 2024
1 parent 570ca32 commit a6251fb
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 1 deletion.
48 changes: 48 additions & 0 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,53 @@ Overview
Installation
------------


Stable release
^^^^^^^^^^^^^^

To install extended-wdm, run this command in your terminal:

.. code-block:: console
$ pip install ewdm
This is the preferred method to install extended-wdm, as it will always install
the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


From sources
^^^^^^^^^^^^

The sources for extended-wdm can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console
$ git clone git://github.com/dspelaez/extended-wdm
Or download the `tarball`_:

.. code-block:: console
$ curl -OJL https://github.com/dspelaez/extended-wdm/tarball/master
Once you have a copy of the source, you can install it with:

.. code-block:: console
$ python setup.py install
.. _Github repo: https://github.com/dspelaez/extended-wdm
.. _tarball: https://github.com/dspelaez/extended-wdm/tarball/master


Conventions
-----------
46 changes: 45 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,52 @@
Welcome to extended-wdm package documentation!
==============================================

*Python toolkit for estimating directional wave spectra of ocean waves*
*EWDM (Extended Wavelet Directional Method) is a Python toolkit for a
wavelet-based estimation of the directional wave spectra*

This algorithm enhances the capabilities of `Donelan's`_ WDM (Wavelet
Directional Method), which is specifically designed to calculate directional
spectra from spatial arrays, extending it to single-point triplet data from
sources like GPS wave buoys, pitch-roll buoys, and Acoustic Doppler Current
Profilers.

The wavelet-based methods for estimating the directional wave spectra have
emerged as a practical alternative to the conventional Fourier-based techniques,
particularly well-suited for the analysis of data from `SOFAR Spotter buoys`_
as demonstrated by `Pelaez-Zapata et al. (2024)`_ and from other triplet data
such as wave slopes as shown by `Krogstad et al. (2006)`_.

Key features of the EWDM include:

* Implementation of the wavelet-based algorithms for extracting directional
information from wave time series.

* Improve estimation of wave directional distribution using KDE (Kernel Density
Estimation)

* Tools for processing and visualising directional wave data.

* Powered by `xarray` labelled multi-dimensional arrays.

* Helper functions to handle commonly used data sources such as `SOFAR Spotter
buoys`_ and `CDIP database`_.

* Documentation, examples, and comparison with conventional methods.

.. _Donelan's: https://doi.org/10.1175/1520-0485(1996)026<1901:naotdp>2.0.co;2
.. _Pelaez-Zapata et al. (2024): https://doi.org/10.1175/JTECH-D-23-0058.1
.. _Krogstad et al. (2006): https://onepetro.org/IJOPE/article-abstract/28936/Wavelet-And-Local-Directional-Analysis-of-Ocean?redirectedFrom=fulltext
.. _SOFAR Spotter buoys: https://www.sofarocean.com/products/spotter
.. _CDIP database: https://cdip.ucsd.edu/


Whether you are a researcher, student, or engineer in physical oceanography, the
Extended Wavelet Directional Method provides a powerful, user-friendly toolkit
for in-depth analysis of directional ocean wave spectra. Join us in exploring
the fascinating world of directional wave analysis and making meaningful
contributions to the understanding of ocean wave dynamics. We welcome
contributions, feedback, and collaboration from the community to further enhance
the capabilities of the Extended Wavelet Directional Method.


.. note::
Expand Down

0 comments on commit a6251fb

Please sign in to comment.