Documentation

Everything you need to know about AquaScope's 30+ modules. Screenshots, features, and technical guides.

🚀
Quick Start
Installation & setup
📡
API Reference
All endpoints
🐳
Deployment
Docker Compose
🧪
Testing
719 tests, all green

Feature Guide

Core

Dashboard

Your aquarium command center. See all tanks at a glance with sparklines, health badges, and recent activity.

  • Multi-tank overview with parameter sparklines
  • Maturity badges and alert indicators
  • Overdue maintenance and feeding reminders
  • Recent activity feed
  • Tank-specific tips and seasonal nudges
DashboardDashboard
Tank ManagementTank Management
Core

Tank Management

Manage multiple tanks with detailed profiles. Saltwater, freshwater, or brackish — 17 subtypes supported.

  • Display + sump volume tracking
  • Tank images, archiving, refugium support
  • Report cards with 6-category health scoring
  • Visual timeline with events and milestones
  • Share via public link or delegate to other users
Core

Water Parameters

Track calcium, alkalinity, magnesium, pH, salinity, and any custom parameter. Ideal ranges adapt automatically to your tank type across 17 subtypes.

  • 11 built-in parameters + unlimited custom (iodine, strontium, silicate, etc.)
  • Tank-type-aware ideal ranges: SPS, LPS, FOWLR, Planted, Discus, Shrimp, and 11 more
  • Interactive charts with zoom (1W/1M/3M/1Y/All) + warning zones
  • Smart alerts when readings go out of range
  • Correlation analysis with maintenance activities
ParametersParameters
LivestockLivestock
Living

Livestock & Compatibility

Track every fish, coral, and invertebrate. Compatibility checking with an 8-rule engine.

  • Auto-photos from iNaturalist/FishBase/WoRMS
  • Compatibility heatmap matrix + network graph
  • Per-creature timeline (added, moved, died)
CompatibilityCompatibility
Core

Maintenance

Never miss a water change or filter cleaning. Recurring reminders with auto-complete on parameter submission.

  • Recurring schedules with custom frequencies
  • Overdue alerts with push notifications
  • Completion log with history
MaintenanceMaintenance
EquipmentEquipment
Upkeep

Equipment

Inventory every piece of equipment. Track warranties, power consumption, and maintenance links.

  • Warranty tracking with expiry badges
  • Power consumption per tank (kWh + cost)
  • Convert to/from consumable
Daily Care

Consumables

Track salt mix, additives, food, filter media, and test kits. Auto-status transitions.

  • Smart status: active → low_stock → depleted
  • Refill tracking with source linking
  • Low-stock push notifications
ConsumablesConsumables
FeedingFeeding
Daily Care

Feeding

Schedules, logs, and a weekly calendar. Link to consumables for automatic stock tracking.

  • Recurring schedules with frequency
  • Weekly calendar with overdue indicators
  • Mark-as-fed with one click
Daily Care

Dosing

Manage calcium, alkalinity, magnesium, and supplement dosing. Calculator, reservoir tracking, and timeline.

  • Dosing calculator with brand presets
  • Reservoir management with auto-deduction
  • Dosing timeline with consumable links
DosingDosing
DiseasesDiseases
Daily Care

Disease Tracking

Document outbreaks, track treatments, and monitor recovery. 32 disease guides built in.

  • Disease records with severity and status
  • Treatment log with medication tracking
  • Related photos for visual documentation
BreedingBreeding
Daily Care

Breeding

Track breeding projects from courtship to fry. Spawning logs, egg care, and fry count tracking.

  • Project lifecycle (planning → spawning → raising fry)
  • Event logs with fry count tracking
Daily Care

Water Changes

Smart calculator with 4 tabs: log, correction plan, target parameter, and impact preview.

  • Dilution calculator with live preview
  • Built-in salt mix presets
  • Water change timeline
Water ChangesWater Changes
LightingLighting
Daily Care

Lighting

Multi-channel LED schedule management with 6 built-in presets and area charts.

  • Multi-channel intensity curves
  • 6 built-in presets (SPS, LPS, FOWLR, etc.)
Analysis

Finances

Track spending by category and tank. Budgets, monthly charts, and electricity costs.

  • Category breakdown
  • Monthly spending charts
  • Budget tracking with alerts
FinancesFinances
Analysis

ICP Tests

Upload lab PDFs (ATI, Triton, Fauna Marin) or enter results manually. AquaScope tracks 50+ elements across 5 groups with quality scores and status indicators.

  • Auto-parse ATI/Triton/Fauna Marin PDFs
  • 50+ elements: major, minor, nutrients, pollutants
  • Quality scores (0–100) per element group
  • Multi-water type: saltwater + RO from one PDF
  • Cross-test comparison over time
  • AI Deep Analysis with dosing recommendations (Pro+)

Elements Tracked

Base: Salinity, KH
Major (10): Cl, Na, Mg, S, Ca, K, Br, Sr, B, F
Minor (18): Li, Si, I, Ba, Mo, Ni, Mn, As, Be, Cr, Co, Fe, Cu, Se, Ag, V, Zn, Sn
Nutrients: NO₃, P, PO₄
Pollutants (10): Al, Sb, Bi, Pb, Cd, La, Tl, Ti, W, Hg
Social

Sharing & Public Profiles

Share your tank with a public link or delegate access to family and technicians.

  • One-click public share link
  • Invite users by email (read/write access)
  • Revocable tokens with expiry
ShareShare
CommunityCommunity
Social

Community

Opt-in community with pseudonymous profiles. Browse tanks, follow aquarists, and exchange frags.

  • Tank gallery with likes and comments
  • Follow system with activity feed
  • Species reviews and ratings
  • Frag/livestock exchange marketplace
  • Tank of the Week
Admin

Admin Panel

User management, system health, backups, and module configuration.

  • User management (edit, suspend, sudo, delete)
  • Module toggles and feature gating
  • Backup create/restore/download
  • Analytics dashboard with world map
AdminAdmin
Architecture

Tech Stack

FastAPI
Python 3.11 backend
React 18
TypeScript + Vite
PostgreSQL
40+ models
InfluxDB
Time-series parameters
Docker
5-service compose
Tailwind
Dark/light themes
15 Languages
i18next + 35 namespaces
719 Tests
All passing