Usage

---

3. Usage Guide (Usage.md)

This page explains how to run an analysis.

# Usage Guide

This guide outlines the steps to run a `pat2vec` analysis after completing the installation.

### 1. Finalize Project Setup

Ensure your project directory is set up correctly.

1.  **Populate `credentials.py`**: In the parent directory of your `pat2vec` clone, edit `credentials.py` with your Elasticsearch credentials.
2.  **Add MedCAT Model**: Copy your MedCAT model pack (`.zip`) into the `medcat_models` directory.

Your final directory structure should look like this: