Examples and Implementations

Implementations and Example Notebooks¶

This section collects raw and notebook implementations of key papers and ideas equivariant filtering. All notebooks are rendered directly on the site via MyST / Jupyter Book, so you can see code, equations, and figures inline.

🚀 Running Notebooks Locally¶

# Clone the repository
git clone https://github.com/borglab/AwesomeEqF.git
cd AwesomeEqF

# Create a virtual environment using uv
uv sync
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install dependencies
uv add -r notebooks/requirements.txt

cd notebooks

# Launch Jupyter
jupyter notebook

🤝 Contributing Implementations¶

If you would like to teach about a topic in the realm of EqFs, please create a notebook!

1. Create your notebook following our existing style in notebooks/.

2. Ensure it runs without errors from a clean environment.

3. Add clear explanations and visualizations.

4. Submit a pull request.

See our Contributing Guide for more details.