How cywhale/glodap works
Project type and purpose
• From the README (“GLODAP Open API”) and file tree, this is a data-centric web API service written in Python. Its purpose is to expose GLODAP (Global Ocean Data Analysis Project) version 2.2023 data via a RESTful interface.
• It ingests raw JSON/CSV data (in data/), transforms/stores it (dev scripts and possibly a Postgres backend), and serves it through glodap_app.py (the main application), with supporting library code under src/.
File structure
Top‐level and key directories:
• glodap_app.py – the entry point for the API service (likely using Flask or FastAPI).
• src/ – application modules (e.g., cruise_metadata.py).
• data/ – source datasets (JSON and CSV).
• dev/ – development/ETL scripts (cruise2table.py, glodap2postgres.ipynb) to load or prepare data.
• conf/ – deployment/configuration:
– ecosystem.config.js (PM2 or similar process manager config)
– simu.sh (simulation or startup script).
• requirements.txt – Python dependencies.
Patterns & components:
• ETL layer (scripts under dev/)
• Data storage (implied PostgreSQL or similar, given the notebook)
• API application (Python service)
• Deployment/config (PM2, shell scripts)
README for additional insights
• Under construction, but attribution section confirms data source and suggests read-only, queryable dataset.