Getting Started¶

Welcome to the Loom documentation! 🎉

This guide will help you set up Loom on your machine and run your first tests.

Installing from Github¶

TODO

Installing from source¶

1. Clone the repository¶

git clone https://github.com/entropicalabs/el-loom.git
cd el-loom

2. Install Poetry¶

Loom uses Poetry for dependency management.
We recommend installing Poetry in a dedicated virtual environment.

Run the installer:

curl -sSL https://install.python-poetry.org | python3 -
export PATH="$HOME/.local/bin:$PATH"

Make Poetry available permanently by adding it to your shell config:

# For Bash
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# For Zsh (default on Mac)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

3. Install Loom with Poetry¶

Inside the project folder:

poetry install

This will install Loom and all required dependencies inside a Poetry-managed virtual environment.

4. Optional configurations¶

Keep the virtual environment inside the project directory:
```
poetry config virtualenvs.in-project true
```

Install extra dependencies (if you plan to contribute, build docs, or use Jupyter notebooks):

poetry install --with dev        # Development
poetry install --with docs       # Documentation
poetry install --with notebooks  # Jupyter Notebooks

5. Run the tests¶

Make sure everything works:

poetry run pytest

If all tests pass, you’re ready to use Loom! 🚀

If you run into issues, check the Poetry documentation or open an issue on GitHub.