warehack.ing/birdcage-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add uvx install instructions and PyPI package references

Browse source 
Three pages updated: home, getting-started, TUI guide.
All now show uvx as the primary install method with tabbed
alternatives for pip install and from-source. Documents the
camera extra and lists all three PyPI packages.
This commit is contained in:
Ryan Malloy 2026-02-17 18:42:22 -07:00
parent 7da16815ec
commit 75f8de90c1
3 changed files with 103 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

48
src/content/docs/guides/tui.mdx
View file

@ -27,26 +27,44 @@ Birdcage is what happens when you take all of that and give it a proper interfac
## Quick Start
<Steps>
1. **Clone and install** (from the `tui/` directory inside the Birdcage repo):
<Tabs>
<TabItem label="uvx (no clone needed)">
```bash
# Demo mode — no hardware, no clone, no install
uvx birdcage-tui --demo
```bash
cd tui/
uv sync
```
# With camera capture support (Pillow + astropy)
uvx --with 'birdcage-tui[camera]' birdcage-tui --demo
2. **Run in demo mode** (no hardware required):
# Connect to a real dish
uvx birdcage-tui --port /dev/ttyUSB0 --firmware g2
```
</TabItem>
<TabItem label="From source">
```bash
# Clone and install
cd tui/
uv sync
```bash
uv run birdcage-tui --demo
```
# Demo mode
uv run birdcage-tui --demo
3. **Connect to a real dish:**
# Connect to a real dish
uv run birdcage-tui --port /dev/ttyUSB0 --firmware g2
```
</TabItem>
</Tabs>
```bash
uv run birdcage-tui --port /dev/ttyUSB0 --firmware g2
```
</Steps>
### Extras
The base install includes everything except image processing. Optional extras add camera capabilities:
| Extra | Install | What it adds |
|-------|---------|-------------|
| *(base)* | `uvx birdcage-tui` | Full TUI, all 6 screens, demo mode |
| `camera` | `uvx --with 'birdcage-tui[camera]' birdcage-tui` | JPEG annotation (Pillow) + FITS export for radio astronomy (astropy) |
The camera screen (F6) works without the `camera` extra — it falls back to minimal JPEG output. The extra adds annotated frames and FITS file export for integration with DS9, CASA, and other astronomy tools.
<Aside type="tip">
Demo mode simulates a complete Carryout G2 — motor physics at 10°/s with settling noise,