-
Notifications
You must be signed in to change notification settings - Fork 8
[optional] Thorough docs review PR #177
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
39bd4ed
75d5ce5
aff8568
ca5ea30
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,12 +2,7 @@ | |
|
|
||
| ## Overview | ||
|
|
||
| CA-Biositing is a comprehensive geospatial bioeconomy platform for biodiversity | ||
| data management and analysis, specifically focused on California biositing | ||
| activities. The project combines ETL data pipelines, REST APIs, geospatial | ||
| analysis tools, and web interfaces to support biodiversity research and | ||
| conservation efforts. It processes data from Google Sheets into PostgreSQL | ||
| databases and provides both programmatic and visual access to the data. | ||
| The CA-Biositing system ingests agricultural and geospatial data from multiple external sources to support biomass siting analysis and related decision-making workflows. This architecture document describes how data flows through ETL pipelines, is validated and stored in relational and geospatial databases, and is orchestrated using workflow tooling. The diagram below provides a high-level view of the core services, data stores, and integrations that make up the platform. | ||
|
|
||
| ## System Architecture Diagram | ||
|
|
||
|
|
@@ -95,7 +90,7 @@ end | |
| ### Backend Infrastructure | ||
|
|
||
| - **Programming Language**: Python 3.12+ | ||
| - **Database**: PostgreSQL 13+ with PostGIS extension | ||
| - **Database**: PostgreSQL 13+ (17 in dev/staging) with PostGIS extension | ||
|
mglbleta marked this conversation as resolved.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Database version inconsistency with line 127-128. Line 89 states PostgreSQL 17 is used in "dev/staging", but lines 127-128 state "PostgreSQL 17+ with PostGIS (Cloud SQL on GCP for production, local PostGIS for development)". This creates confusion about which environments use which PostgreSQL versions. Please clarify:
🤖 Prompt for AI Agents |
||
| - **Database Migrations**: Alembic for schema versioning | ||
| - **Data Models**: SQLModel (combining SQLAlchemy + Pydantic) | ||
| - **API Framework**: FastAPI with automatic OpenAPI documentation | ||
|
|
@@ -127,13 +122,15 @@ end | |
|
|
||
| ### Cloud Infrastructure & Services | ||
|
|
||
| - **Google Cloud Platform**: | ||
| - **Google Cloud Platform (GCP):** | ||
| - Google Sheets API for data ingestion | ||
| - Google Cloud credentials management | ||
| - Potential cloud deployment target | ||
| - **Database Hosting**: Containerized PostgreSQL (development), cloud SQL | ||
| (production) | ||
| - **Container Registry**: For Docker image distribution | ||
| - Google Cloud Secret Manager for credentials | ||
| - **Production deployment:** All core infrastructure (database, application | ||
| containers, orchestration, and secrets) runs on GCP using Cloud SQL, Cloud | ||
| Run, Artifact Registry, and Secret Manager | ||
| - **Database Hosting:** PostgreSQL 17+ with PostGIS (Cloud SQL on GCP for | ||
|
|
||
| production, local PostGIS for development) | ||
| - **Container Registry:** GCP Artifact Registry for Docker images | ||
|
|
||
| ## Detailed Project Structure | ||
|
|
||
|
|
@@ -319,6 +316,10 @@ subdirectories (91 models total). Four base mixins (`BaseEntity`, `LookupBase`, | |
|
|
||
| #### Resource & Biomass Models (`resource_information/`) | ||
|
|
||
| <!-- | ||
| TODO (2026-03-12): The "Core Domain Models" section below may be outdated. Review for accuracy in the next documentation update. | ||
| --> | ||
|
|
||
| - **Resource**: Core biomass resource definitions | ||
| - **ResourceClass**, **ResourceSubclass**: Hierarchical resource classification | ||
| - **ResourceAvailability**: Seasonal and quantitative availability data | ||
|
|
@@ -509,6 +510,10 @@ Environments: | |
|
|
||
| ## Deployment & Operations | ||
|
|
||
| <!-- | ||
| TODO (2026-03-12): Could change section to be less heavily bullet point reliant and use more descriptive language, with greater explanation of future architecture considerations as well. | ||
| --> | ||
|
|
||
| ### Container Orchestration | ||
|
|
||
| - **Development**: Docker Compose for local services | ||
|
|
||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Uh oh!
There was an error while loading. Please reload this page.