Echotools Library

Welcome to the Echotools library — a collection of utility functions designed to read B-mode ultrasound videos and convert them to and from AMM image space.

Directory structure

---

🌲 
├── 📁 build
│   ├── 📄 requirements.txt
│   └── 📄 RUN_TESTS.bat
├── 📁 src
│   ├── 📄 __init__.py
│   ├── 📄 cone.py
│   ├── 📄 coords.py
│   ├── 📄 file.py
│   ├── 📄 h5.py
│   ├── 📄 heatmaps.py
│   ├── 📄 movie.py
│   └── 📄 SL.py
└── 📄 Readme.md

Using echotools as a Git Submodule

This guide explains how to include the echotools library as a Git submodule in your project, set it in the Python path, and import it using import echotools.

---

1. Add echotools as a Git Submodule

In your main project directory, run the following command:

git submodule add <repository-url> echotools
git submodule update --init --recursive

Replace <repository-url> with the actual Git URL of the echotools repository.

---

2. Add echotools to the Python Path

To make the echotools module importable, you need to add it to your Python path.

Option A: Temporarily via environment variable

export PYTHONPATH=$PYTHONPATH:$(pwd)/echotools

Option B: Programmatically in your script

import sys
import os
sys.path.append(os.path.join(os.path.dirname(__file__), 'echotools'))

import echotools

---

3. Import and Use

Once the path is set, you can import the library in your Python code:

import echotools

# Example usage
echotools.read_bmode_video("example.avi")

---

4. (Optional) Add to .gitmodules

Ensure your .gitmodules file is tracked and committed so others can clone the repo with submodules:

git add .gitmodules echotools
git commit -m "Add echotools as a submodule"

---

Let me know if you'd like this saved as a downloadable file or tailored for a specific environment (e.g., Jupyter, Docker, etc.).