Skip to content

Commit 85ab561

Browse files
committed
added new sensors and improvement for saildrone processing
1 parent 3872a47 commit 85ab561

146 files changed

Lines changed: 33304 additions & 11356 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/.gitkeep

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Documentation Site Structure Created
2+
# Placeholder files generated for documentation sections

docs/BUILD_INSTRUCTIONS.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Building the Documentation Site
2+
3+
## Quick Start
4+
5+
```bash
6+
# Install dependencies
7+
pip install -r docs-requirements.txt
8+
9+
# Serve locally (with live reload)
10+
cd docs-site
11+
mkdocs serve
12+
13+
# Open http://127.0.0.1:8000 in browser
14+
```
15+
16+
## Build Static Site
17+
18+
```bash
19+
cd docs-site
20+
mkdocs build
21+
22+
# Output in: site/
23+
# Deploy to GitHub Pages, Netlify, etc.
24+
```
25+
26+
## Deploy to GitHub Pages
27+
28+
```bash
29+
cd docs-site
30+
mkdocs gh-deploy
31+
32+
# Automatically builds and pushes to gh-pages branch
33+
# Site will be at: https://oceanstreamio.github.io/oceanstream-newcli/
34+
```
35+
36+
## Using with Docker
37+
38+
```bash
39+
# Serve with Docker
40+
docker run --rm -it -p 8000:8000 -v ${PWD}/docs-site:/docs squidfunk/mkdocs-material
41+
42+
# Build with Docker
43+
docker run --rm -it -v ${PWD}/docs-site:/docs squidfunk/mkdocs-material build
44+
```
45+
46+
## Directory Structure
47+
48+
The docs-site/ folder is self-contained and can be built independently from the main project.
49+
50+
All markdown files reference each other relatively, so the site can be browsed as plain files OR built with MkDocs.

docs/MISSING_DOCS.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Missing Documentation Pages
2+
3+
This document tracks documentation pages that are referenced but not yet created. These references have been commented out in the current documentation to prevent broken link warnings.
4+
5+
## High Priority
6+
7+
### API Reference
8+
- **api-reference/cli-reference.md** - Complete CLI command reference
9+
- **api-reference/python-api.md** - Python API documentation
10+
11+
### Core Guides
12+
- **guide/core-concepts/processing-pipeline.md** - Detailed pipeline explanation
13+
14+
## Medium Priority
15+
16+
### Advanced Topics
17+
- **guide/advanced/append-update.md** - Incremental data processing guide
18+
19+
### Architecture
20+
- **guide/architecture/storage-providers.md** - Storage provider system design
21+
22+
### Integration Guides
23+
- **guide/integrations/azure-storage.md** - Azure-specific integration details
24+
- **gis-integration/qgis.md** - QGIS integration guide
25+
26+
### Feature Guides
27+
- **guide/features/sensor-detection.md** - Sensor detection algorithm details
28+
- **guide/features/semantic-enrichment.md** - CF Standard Names enrichment
29+
- **guide/features/pmtiles-generation.md** - PMTiles generation guide
30+
31+
## Low Priority
32+
33+
### Example Workflows
34+
- **guide/examples/saildrone-multi-platform.md** - Multi-platform processing
35+
- **guide/examples/saildrone-append.md** - Append workflow example
36+
- **guide/examples/saildrone-cloud.md** - Cloud upload example
37+
- **guide/examples/saildrone-timeseries.md** - Time series analysis
38+
- **guide/examples/saildrone-spatial.md** - Spatial analysis
39+
- **guide/examples/saildrone-sensors.md** - Sensor-specific processing
40+
41+
### Data Provider Guides
42+
- **guide/features/data-providers/creating-providers.md** - Custom provider development
43+
- **guide/features/data-providers/semantic-mappings.md** - Cross-provider interoperability
44+
45+
### Individual Sensor Pages
46+
- **guide/features/supported-sensors/apogee-si111.md** - Apogee SI-111 IR Radiometer
47+
- **guide/features/supported-sensors/imu-navigation.md** - IMU & GPS Navigation
48+
- **guide/features/supported-sensors/wave-imu.md** - IMU-Derived Wave Sensor
49+
- **guide/features/supported-sensors/licor-li190r.md** - LI-COR LI-190R (covered in radiation-sensors.md)
50+
- **guide/features/supported-sensors/kipp-zonen-cmp.md** - Kipp & Zonen CMP (covered in radiation-sensors.md)
51+
52+
### Additional Pages
53+
- **about/faq.md** - Frequently Asked Questions
54+
55+
## Implementation Notes
56+
57+
### Sensors Already Documented
58+
- LI-COR LI-190R and Kipp & Zonen CMP are documented in `guide/features/supported-sensors/radiation-sensors.md`
59+
- Links have been updated to point to anchor sections in that page
60+
61+
### Commented Links
62+
All links to missing pages have been replaced with HTML comments like:
63+
```markdown
64+
<!-- TODO: Add [page-name] guide -->
65+
```
66+
67+
This prevents broken link warnings while preserving the intent to create these pages.
68+
69+
## Status: Clean Build ✅
70+
71+
As of the latest build, there are **zero broken link warnings**. The documentation builds successfully with only informational messages about:
72+
- README.md exclusion (expected)
73+
- Anchor link recommendations (optional optimization)

docs/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# OceanStream Documentation Site
2+
3+
Structured documentation for the OceanStream Data Ingestion project.
4+
5+
## Quick Start
6+
7+
```bash
8+
# Install dependencies
9+
pip install -r docs-requirements.txt
10+
11+
# Serve locally
12+
mkdocs serve
13+
14+
# Open http://127.0.0.1:8000
15+
```
16+
17+
## Structure
18+
19+
- `getting-started/` - Installation, quick start, configuration
20+
- `user-guide/` - CLI reference, data formats, workflows
21+
- `features/` - Feature documentation (GeoTrack, NMEA, STAC, etc.)
22+
- `integrations/` - External tool integrations
23+
- `architecture/` - System design and architecture
24+
- `api-reference/` - API documentation
25+
- `contributing/` - Development guidelines
26+
- `examples/` - Code examples and tutorials
27+
- `reference/` - FAQ, glossary, troubleshooting
28+
29+
## Building
30+
31+
See [BUILD_INSTRUCTIONS.md](BUILD_INSTRUCTIONS.md) for detailed build instructions.

docs/about/changelog.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Changelog
2+
3+
All notable changes to OceanStream will be documented here.
4+
5+
## [Unreleased]
6+
7+
### Added
8+
- Storage provider system with Azure, Local support
9+
- Configuration management with encrypted credentials
10+
- Spatial binning with Hive partitioning
11+
- STAC metadata generation
12+
- Sensor detection system
13+
- PMTiles generation (optional)
14+
- Deduplication with file tracking
15+
- Campaign-based organization
16+
17+
### Documentation
18+
- Complete documentation site structure
19+
- Getting started guides
20+
- API reference
21+
- Contributing guidelines
22+
23+
## [Pre-1.0]
24+
25+
Working towards first stable release.
26+
27+
---
28+
29+
**Note**: This project follows [Semantic Versioning](https://semver.org/) after v1.0.0.

docs/about/glossary.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Glossary
2+
3+
## Terms
4+
5+
**Campaign**
6+
: A collection of related oceanographic data from a single mission or cruise. Used as the top-level organizational unit in OceanStream.
7+
8+
**GeoParquet**
9+
: Columnar file format (Apache Parquet) with geospatial extensions for storing geographic data efficiently.
10+
11+
**Hive Partitioning**
12+
: Data organization strategy using directory structure (e.g., `lat_bin=10/lon_bin=-126/`) for efficient spatial queries.
13+
14+
**PMTiles**
15+
: Vector tile format for web-based map visualization. Stores map data in a single file with spatial indexing.
16+
17+
**R2R**
18+
: Rolling Deck to Repository - a platform for managing oceanographic cruise data.
19+
20+
**Spatial Binning**
21+
: Organizing data into geographic grid cells (default: 1°×1° lat/lon bins).
22+
23+
**STAC**
24+
: SpatioTemporal Asset Catalog - a standard for geospatial metadata that enables data discovery.
25+
26+
**Storage Provider**
27+
: Abstraction layer for uploading data to different backends (Local, Azure, S3, GCS).
28+
29+
## Next Steps
30+
31+
- <!-- TODO: Add FAQ page --> - Common questions
32+
- [Guide](../getting-started/installation.md) - Get started

0 commit comments

Comments
 (0)