Metadata-Version: 2.4
Name: echosms
Version: 0.24.0
Summary: Acoustic backscattering models used in aquatic ecosystem research
Project-URL: Homepage, https://github.com/ices-tools-dev/echoSMs
Project-URL: Issues, https://github.com/ices-tools-dev/echoSMs/issues
Project-URL: Documentation, https://ices-tools-dev.github.io/echoSMs
Project-URL: Repository, https://github.com/ices-tools-dev/echoSMs
Project-URL: Discussions, https://github.com/ices-tools-dev/echoSMs/discussions
Author: Mike Jech, Gavin Macaulay
License-Expression: MIT
License-File: LICENSE
Keywords: acoustic,backscatter,model
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Oceanography
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Requires-Dist: jsonschema-rs
Requires-Dist: manifold3d
Requires-Dist: mapbox-earcut
Requires-Dist: mapply
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: orjson
Requires-Dist: pandas
Requires-Dist: pymeshlab
Requires-Dist: requests
Requires-Dist: rich
Requires-Dist: rtoml
Requires-Dist: scipy
Requires-Dist: shapely
Requires-Dist: spheroidalwavefunctions
Requires-Dist: tqdm
Requires-Dist: trimesh
Requires-Dist: urllib3>=2.7.0
Requires-Dist: xarray
Description-Content-Type: text/markdown

# echoSMs

[![Static badge](https://img.shields.io/pypi/v/echosms.svg)](https://pypi.org/project/echosms/)
[![Static badge](https://img.shields.io/github/license/ices-tools-dev/echosms)](https://raw.githubusercontent.com/ices-tools-dev/echoSMs/refs/heads/main/LICENSE)
[![python](https://img.shields.io/pypi/pyversions/echosms.svg?logo=python&logoColor=white)](https://pypi.org/project/echosms/)

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ices-tools-dev/echoSMs/publish-to-pypi.yml)](https://github.com/ices-tools-dev/echoSMs/actions/workflows/publish-to-pypi.yml)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ices-tools-dev/echoSMs/build-docs.yml?label=docs)](https://github.com/ices-tools-dev/echoSMs/actions/workflows/build-docs.yml)

> Making acoustic scattering models available to fisheries and plankton scientists via the world wide web

EchoSMs provides acoustic scattering models for fisheries and plankton acoustic research. By providing the models in an open-access and open-source software language (e.g, Python, R) and providing morphological and anatomical data in open data formats (e.g., HDF5, relational databases), the proper and appropriate use of these models can extend to the entire fisheries and plankton acoustics’ community.

## Install

EchoSMs is available on the python Package Index as [echosms](https://pypi.org/project/echosms/) and will be available on conda-forge in the future.

To install the core library:
```bash
pip install echosms
```

To install with the optional GUI shape viewer:
```bash
pip install echosms[viewer]
```

## Documentation

EchoSMs documentation is available [here](https://ices-tools-dev.github.io/echoSMs/).

## Viewer

EchoSMs includes a GUI tool for visualizing organism shapes. If installed with the `[viewer]` option, you can launch it using:

```bash
echosms-view
```

## Contributing

We welcome all contributions to echoSMs, be it code, test cases, bug reports, discussion of models, etc. Guidance on this is available in the echoSMs [documentation](https://ices-tools-dev.github.io/echoSMs/#contributing-to-echosms).
