README.md

llms-for-planning

Setup

1. Create and activate your virtual environment. We recommend using pyenv and pyenv-virtualenv.

   pyenv virtualenv 3.9.13 llms-for-planning
   pyenv activate llms-for-planning

2. Update the submodules

   git submodule update --init --recursive

3. Install pygraphviz and pip install it

   # Assuming you brew installed graphviz
   export GRAPHVIZ_DIR="$(brew --prefix graphviz)"
   pip install pygraphviz \
       --global-option=build_ext \
       --global-option="-I$GRAPHVIZ_DIR/include" \
       --global-option="-L$GRAPHVIZ_DIR/lib"

4. Install the requirements

   pip install -r requirements.txt

5. Copy the .envrctemplate and fill in the necessary environment variables. Consider using direnv.

   cp .envrctemplate .envrc
   # Fill in variables and save file
   direnv allow .