Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
# .github
Home for open-source tools and resources in ocean acoustics

This repository contains the GitHub organization profile for the **echostack-org** organization.
The organization landing page is defined in:
```text
profile/README.md
```
To update the content displayed on the organization homepage, edit `profile/README.md` and submit a pull request.
50 changes: 50 additions & 0 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# echostack

[![SciPy Proceedings](https://img.shields.io/badge/SciPy_2025-Paper-blue)](https://proceedings.scipy.org/articles/WXRH8633)
[![GitHub Organization](https://img.shields.io/badge/GitHub-echostack--org-black?logo=github)](https://github.com/echostack-org)

**echostack** is an open-source ecosystem of interoperable Python packages for processing, analyzing, visualizing, and managing scientific echosounder data.

The ecosystem provides modular and scalable software components for working with water-column sonar data, from raw instrument files to calibrated, analysis-ready data products and downstream ecological interpretation.

<p align="center">
<img src="figures/echostack_packages.png" alt="Overview of the Echostack ecosystem" width="950">
</p>

Built on the Scientific Python ecosystem, Echostack leverages libraries such as **xarray**, **Dask**, **Zarr**, **NetCDF**, **fsspec**, and **pandas**, while integrating with community projects including **regionmask**, **HoloViz**, **Prefect**, and **Pydantic**.

## Core repositories

| Repository | Description | Activity |
| --- | --- | --- |
| [**echopype**](https://github.com/echostack-org/echopype) | Data conversion, calibration, aggregation, and computation for echosounder data. | ![Stars](https://img.shields.io/github/stars/echostack-org/echopype?style=social) ![Last commit](https://img.shields.io/github/last-commit/echostack-org/echopype) |
| [**echopype-examples**](https://github.com/echostack-org/echopype-examples) | Example notebooks and tutorials demonstrating the Echostack ecosystem. | ![Stars](https://img.shields.io/github/stars/echostack-org/echopype-examples?style=social) ![Last commit](https://img.shields.io/github/last-commit/echostack-org/echopype-examples) |
| [**echoregions**](https://github.com/echostack-org/echoregions) | Interfaces echosounder data with annotations, lines, regions, and masks. | ![Stars](https://img.shields.io/github/stars/echostack-org/echoregions?style=social) ![Last commit](https://img.shields.io/github/last-commit/echostack-org/echoregions) |
| [**echopop**](https://github.com/echostack-org/echopop) | Combines acoustic and biological data for population and biomass estimates. | ![Stars](https://img.shields.io/github/stars/echostack-org/echopop?style=social) ![Last commit](https://img.shields.io/github/last-commit/echostack-org/echopop) |
| [**echoshader**](https://github.com/echostack-org/echoshader) | Interactive visualization of large echosounder datasets. | ![Stars](https://img.shields.io/github/stars/echostack-org/echoshader?style=social) ![Last commit](https://img.shields.io/github/last-commit/echostack-org/echoshader) |
| [**echodataflow**](https://github.com/echostack-org/echodataflow) | Workflow orchestration for local and cloud-based echosounder processing pipelines. | ![Stars](https://img.shields.io/github/stars/echostack-org/echodataflow?style=social) ![Last commit](https://img.shields.io/github/last-commit/echostack-org/echodataflow) |
| [**echodataflow-recipes**](https://github.com/echostack-org/echodataflow-recipes) | Example recipes and configurations for Echodataflow workflows. | ![Stars](https://img.shields.io/github/stars/echostack-org/echodataflow-recipes?style=social) ![Last commit](https://img.shields.io/github/last-commit/echostack-org/echodataflow-recipes) |
| [**echolevels**](https://github.com/echostack-org/echolevels) | Proposed processing-level specifications for standardized echosounder data products. | ![Stars](https://img.shields.io/github/stars/echostack-org/echolevels?style=social) ![Last commit](https://img.shields.io/github/last-commit/echostack-org/echolevels) |


## Design principles

The Echostack ecosystem is designed to be:

- **Modular**: repositories can be used independently or combined into larger workflows.
- **Interoperable**: built upon the Scientific Python ecosystem and common open data formats.
- **Scalable**: from personal laptops to HPC clusters and cloud platforms.
- **Open**: community-driven, reproducible, and open-source.

## Scientific publication

A complete overview of the project's motivation, architecture, design principles, and example workflows is available in the SciPy Proceedings paper:

> **[Echostack: A flexible and scalable open-source software suite for echosounder data processing](https://proceedings.scipy.org/articles/WXRH8633)**

## Community

We welcome contributions from researchers, developers, and users of ocean acoustic data.

- For package-specific bugs, feature requests, or documentation improvements, please open an issue or pull request in the relevant repository.
- For cross-repository discussions, shared standards, or organization-wide initiatives, use the **`.github`** repository.
Binary file added profile/figures/echostack_packages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.