openSTB sonar simulation framework

The openSTB sonar simulation is a modular framework for simulating the signals received by a sonar system. It is currently in the early stages of development, so bugs are to be expected.

License

The simulator is available under the BSD-2-Clause plus patent license, the text of which can be found in the LICENSES/ directory or online. Some of the supporting files are under the Creative Commons Zero v1.0 Universal license (effectively public domain). Again, the license is available in the LICENSES/ directory or online.

Documentation

The documentation for the simulator can be viewed at https://docs.openstb.dev

Installation

The simulator is published on PyPI as openstb-simulator. You can use your preferred Python environment management tool to install it. For example, with pip:

pip install openstb-simulator

For more installation options, see the documentation.

Running the simulator

See the examples/ directory for various examples of how to run the simulator. The documentation includes more details of these examples.