Installation

Echopop is available for installation via pip, conda-forge, or by cloning the repository for development.

Danger

Ensure you have Python 3.12 or 3.13 installed, as Python 3.14 has known dependency issues.

pip

Install Echopop directly from PyPI:

pip install echopop

conda-forge

Install Echopop from conda-forge with either Anaconda or Miniconda:

conda install -c conda-forge echopop

Attention

We recommend using the libmamba solver instead of the classic solver. See instructions here for installation and usage.

Latest source

If you need the latest development version or want to contribute, clone the repository and install from source:

# Clone the repository
git clone https://github.com/echostack-org/echopop.git
cd echopop

# Create and activate a conda environment
conda create -c conda-forge -n echopop --yes python=3.12
conda activate echopop

# Optional: Install ipykernel for JupyterLab support
conda install -c conda-forge ipykernel

# Install Echopop in editable mode (-e)
pip install -e .

For a full development environment that includes testing and documentation tools, use:

conda create -c conda-forge -n echopop-dev --yes python=3.12
conda activate echopop-dev
pip install -e ".[dev,docs]"

Development mode

The -e flag means that you are installing Echopop in a development mode, which allows you to not only use but also develop and edit the source code.

Optional: Using WSL on Windows

For Windows users, consider creating environments in Windows Subsystem for Linux (WSL) for improved compatibility with Linux-based tools. See the official WSL documentation for setup instructions.