Metadata-Version: 2.4
Name: echosms
Version: 0.26.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
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.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.12
Requires-Dist: jsonschema-rs>=0.18.1
Requires-Dist: manifold3d>=3.0.0
Requires-Dist: mapbox-earcut>=1.0.2
Requires-Dist: mapply>=0.1.27
Requires-Dist: matplotlib>=3.10.0
Requires-Dist: numpy>=2.2.0
Requires-Dist: orjson>=3.10.7
Requires-Dist: pandas>=2.3.0
Requires-Dist: pymeshlab>=2023.12.post2
Requires-Dist: requests>=2.32.4
Requires-Dist: rich>=13.8.0
Requires-Dist: rtoml>=0.12.0
Requires-Dist: scipy>=1.15.0
Requires-Dist: shapely>=2.0.6
Requires-Dist: spheroidalwavefunctions>=0.0.1
Requires-Dist: tqdm>=4.66.5
Requires-Dist: trimesh>=4.4.4
Requires-Dist: urllib3>=1.26.20
Requires-Dist: xarray>=2024.10.0
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/)
[![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/)


[![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/). To install it:


```bash
uv add echosms
```

or with pip:

```bash
pip install echosms
```

## Documentation

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

## Viewer

EchoSMs includes a tool for visualizing organism shapes. If using uv, start it with:

```bash
uv run echosms-view
```

or if installed with pip:

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