How cdrowley/ceg8719 works
Project Type and Purpose
• This project is a research and coursework submission tool for geospatial data handling. Its main purpose is to collect, preprocess, and document geospatial datasets. It also serves as a development environment that runs both data collection scripts (using notebooks and Python scripts) and a Jupyter Book for curated documentation and analysis.
• In the README, you notice references to “data collection notebooks,” “building the book,” and eventual integration into a cloud PostgreSQL database, which explains the multi-faceted focus: data ingestion, processing, and documentation.
File Structure
• A .devcontainer directory contains Dockerfile and Codespace configuration files. This indicates that the development environment is containerized – essential for reproducibility.
• The .github directory holds the deployment workflow script, suggesting CI/CD is in use.
• Top-level files such as Makefile, environment examples, and configuration files imply scripted tasks for building virtual environments and building the Jupyter book.
• Several directories are key:
• book: Contains the Jupyter book content, including notebooks (.ipynb) and markdown for the book’s chapters (e.g., data_access.md, discussion.md) along with configuration files for Jupytext.
• data: Contains subdirectories for different data sources (cdrc and ons) with parquet and PDF files, clearly intended as the repository for pre-processed data.
• data_collection: Houses data collection notebooks and scripts (both .ipynb and .py), along with utility functions and a TODO file, providing the layer to gather and organize data.
• Supporting files such as requirements_dev.txt and requirements_book.txt indicate separate dependency management for development and book generation.