raschii 1.0.0.dev0

An implementation of stream function wave theory in Python

Raschii is a Python implementation of stream function waves theory

Contents

• Installation and running

• Documentation

• Development

• Releases

• Copyright and license

Rashii is named after the Thysanoessa raschii Arctic Krill.

Installation and running

Raschii can be installed by running:

python3 -m pip install raschii

This will also install dependencies like numpy.

An example of using Raschii from Python:

import raschii

fwave = raschii.FentonWave(height=0.25, depth=0.5, length=2.0)
print(fwave.coefficients)
print(fwave.velocity(x=0, z=0.2))

Documentation

TODO

Development

Raschii is developed in Python on Bitbucket by use of the Git version control system. If you are reading this on github, please be aware that you are seeing a mirror that could potentially be months out of date. All pull requests and issues should go to the Bitbucket repository.

Raschii is automatically tested on CircleCI and the current CI build status is .

Releases

Version 1.0.0 - May XX. 2018

The initial release of Raschii

• Support for Fenton stream functions, Rienecker and Fenton (1981)

Copyright and license

Raschii is copyright Tormod Landet, 2018. Raschii is licensed under the Apache 2.0 license, a permissive free software license compatible with version 3 of the GNU GPL. See the file LICENSE for the details.