> ## Documentation Index
> Fetch the complete documentation index at: https://docs.appliedaifoundation.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Metaweave Voyage Reporting

> Self-contained HTML forms for vessel-side reporting, a local history archive, and a Python pipeline that ingests submissions into PostgreSQL.

<Frame caption="Noon Report — voyage section. The form runs entirely in the browser and submits by email.">
  <img src="https://mintcdn.com/metaweaveconsultant/Yh8TWLsifrpzxzbC/images/hero/form-hero.png?fit=max&auto=format&n=Yh8TWLsifrpzxzbC&q=85&s=f7781009d3afda1080770aaa10641d29" alt="Metaweave form voyage section" width="3004" height="950" data-path="images/hero/form-hero.png" />
</Frame>

## What is this?

Metaweave is a maritime voyage reporting system used by vessels to send daily performance, port, and bunker data back to shore. It has three parts:

<CardGroup cols={3}>
  <Card title="The Form" icon="file-pen" href="/form/overview">
    A single-file HTML form the crew opens in Chrome. Validates input, encrypts the payload, and submits by email.
  </Card>

  <Card title="The History Viewer" icon="folder-open" href="/history/overview">
    A read-only HTML viewer that browses every report the vessel has ever submitted, archived locally as `history.json`.
  </Card>

  <Card title="The Pipeline" icon="server" href="/pipeline/overview">
    A Python ETL that fetches the submission emails from Outlook, decrypts them, and upserts to PostgreSQL.
  </Card>
</CardGroup>

## What it covers

| Report                          | When to send                                            |
| ------------------------------- | ------------------------------------------------------- |
| **Noon Report**                 | Every day at noon, At Sea or In Port                    |
| **Arrival Report**              | At End of Sea Passage (EOSP) on arrival                 |
| **Departure Report**            | At Commencement of Sea Passage (COSP) on departure      |
| **Bunker Report**               | Every time the vessel lifts bunkers                     |
| **Statement of Facts (SOF)**    | After completing cargo ops at one port                  |
| **Delay / Off-Hire Notice**     | When the vessel goes off-hire or experiences a delay    |
| **Cargo Handling**              | Cargo loading / discharge details                       |
| **Terminal Satisfaction Sheet** | Feedback on terminal performance after a port call      |
| **Month-End Bunker Data**       | Bunker ROB reconciliation on the last day of each month |

## Who it's for

* **Vessel Masters and officers** — fill the daily forms and click Submit.
* **Shore performance teams** — receive the emails, run the pipeline, query PostgreSQL.
* **Office staff** — pre-configure the form per vessel (IMO, validation limits) and ship the bundle to each ship.
* **Anyone reviewing past reports** — open the History Viewer, browse, export to Excel/CSV.

## What's next

<CardGroup cols={2}>
  <Card title="5-minute tour" icon="bolt" href="/quickstart">
    From opening the form to a row in Postgres — the whole loop in one walkthrough.
  </Card>

  <Card title="Filling a Noon Report" icon="ship" href="/form/filling-reports">
    Section-by-section walkthrough of each report type.
  </Card>

  <Card title="Setting up history.json" icon="database" href="/history/setup">
    How the office configures the form, links the file on the vessel, and what gets archived per Submit.
  </Card>

  <Card title="Running the pipeline" icon="terminal" href="/pipeline/running">
    `python -m src.main` — fetch from Outlook, decrypt, upsert.
  </Card>
</CardGroup>