documented setup

README.md

@@ -1,5 +1,18 @@
 # MANTRA: Manifold Triangulations
 
+## Setup
+
+0. Clone with submodules. After cloning, run `git submodule update --init --recursive`
+1. Setup python version 3.10.13. E.g. with `pyenv install 3.10.13` and `pyenv local 3.10.13`. Set up a virtual environment, e.g. via `python3 -m venv ./venv` and `source ./venv/bin/activate`,
+2. Install dependencies via poetry
+```s
+$ pip install --upgrade pip
+$ pip install poetry
+$ poetry install
+```
+3. Install toponetx dependency
+4. `pip install -e ./mantra/`
+
 ## Usage
 
 1. `python generate_configs.py`

models/__init__.py

@@ -0,0 +1 @@
+from .models import ModelType, model_lookup, ModelConfig, model_cfg_lookup