2. Wavesim Development

2.1. Running the tests and examples

To download the source code, including tests and examples, clone the repository from GitHub [7]. Wavesim uses poetry [10] for package management, so you have to download and install Poetry first. Then, navigate to the location where you want to store the source code, and execute the following commands to clone the repository, set up the poetry environment, and run the tests.

git clone https://github.com/IvoVellekoop/wavesim_py
cd wavesim_py
poetry install --with dev --with docs
poetry run pytest

The examples are located in the examples directory. Note that a lot of functionality is also demonstrated in the automatic tests located in the tests directory. As an alternative to downloading the source code, the samples can also be copied directly from the example gallery on the documentation website [11].

2.2. Building the documentation

The html, and pdf versions of the documentation, as well as the README.md file in the root directory of the repository, are automatically generated from the docstrings in the source code and reStructuredText source files in the repository.

Note that for building the pdf version of the documentation, you need to have xelatex installed, which comes with the MiKTeX distribution of LaTeX [12]. Then, run the following commands to build the html and pdf versions of the documentation, and to auto-generate README.md.

poetry shell
cd docs
make clean
make html
make markdown
make latex
cd _build/latex
xelatex wavesim
xelatex wavesim

2.3. Reporting bugs and contributing

Bugs can be reported through the GitHub issue tracking system. Better than reporting bugs, we encourage users to contribute bug fixes, optimizations, and other improvements. These contributions can be made in the form of a pull request [13], which will be reviewed by the development team and integrated into the package when appropriate. Please contact the current development team through GitHub [7] or the www.wavesim.org forum to coordinate such contributions.