# INFRA-COMPASS Examples and Tutorials

This directory contains several examples/tutorials to help you get started with ``COMPASS``.

- [`Configuration and Execution Basics`](./execution_basics): Learn how to configure and execute
  a ``COMPASS`` run, starting with basic inputs and working your way up to a full configuration file.
- [`Quickstart Demo`](./openai_solar_demo): Small demo designed to get you running ``COMPASS``
  as fast as possible. Requires a personal OpenAI API key.
- [`Run Texas Water Rights Extraction`](./water_rights_demo): An example setup for running
  COMPASS water rights extraction for a groundwater conservation district in Texas.
- [`One-Shot Extraction`](./one_shot_schema_extraction): A tutorial and some example configurations
  for setting up a custom one-shot extraction plugin within COMPASS.
- [`Parse a Local PDF File`](./parse_existing_docs): A simple example of parsing a local PDF
  file for structured solar ordinance values.

For rendered versions of these guides, see the
[online documentation](https://natlabrockies.github.io/COMPASS/examples/index.html).
