Metadata-Version: 2.4
Name: openstb-simulator
Version: 0.8.0
Summary: Open-source sonar simulation toolbox
Project-URL: Homepage, https://openstb.dev
Project-URL: Documentation, https://docs.openstb.dev
Project-URL: Repository, https://github.com/openstb/simulator.git
Project-URL: Issues, https://github.com/openstb/simulator/issues
Requires-Python: >=3.12
Requires-Dist: click
Requires-Dist: cryptography
Requires-Dist: dask[distributed]
Requires-Dist: numpy
Requires-Dist: openstb-i18n
Requires-Dist: quaternionic
Requires-Dist: rich
Requires-Dist: scipy
Requires-Dist: zarr<4,>=3
Provides-Extra: dask-diagnostics
Requires-Dist: dask[diagnostics]; extra == 'dask-diagnostics'
Provides-Extra: dev
Requires-Dist: dask[diagnostics]; extra == 'dev'
Requires-Dist: mkdocs; extra == 'dev'
Requires-Dist: mkdocs-api-autonav; extra == 'dev'
Requires-Dist: mkdocs-material; extra == 'dev'
Requires-Dist: mkdocstrings[python]; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-subtests; extra == 'dev'
Requires-Dist: requests; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: doc
Requires-Dist: mkdocs; extra == 'doc'
Requires-Dist: mkdocs-api-autonav; extra == 'doc'
Requires-Dist: mkdocs-material; extra == 'doc'
Requires-Dist: mkdocstrings[python]; extra == 'doc'
Provides-Extra: mpi
Requires-Dist: dask-mpi; extra == 'mpi'
Requires-Dist: mpi4py; extra == 'mpi'
Provides-Extra: tests
Requires-Dist: pytest; extra == 'tests'
Requires-Dist: pytest-cov; extra == 'tests'
Requires-Dist: pytest-subtests; extra == 'tests'
Requires-Dist: requests; extra == 'tests'
Description-Content-Type: text/markdown

<!--

SPDX-FileCopyrightText: openSTB contributors
SPDX-License-Identifier: BSD-2-Clause-Patent

-->

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](https://spdx.org/licenses/BSD-2-Clause-Patent.html). 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](https://spdx.org/licenses/CC0-1.0.html).


Documentation
-------------

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


Installation
------------

The simulator is published on [PyPI](https://pypi.org) as
[`openstb-simulator`](https://pypi.org/project/openstb-simulator). You can use your
preferred Python environment management tool to install it. For example, with pip:

```console
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.
