Skip to content

📦 Feature Request: Add script to download Case Study 1 sample data using pooch #305

Description

@2320sharon

📦 Feature Request: Add script to download Case Study 1 sample data using pooch

Description

To improve the onboarding experience for new users and make it easier to get started with CoastSeg, it would be helpful to provide a built-in way to download the sample dataset from Case Study 1.

This can be implemented as a new script or function that uses pooch to programmatically download the sample data. This allows users to quickly access and experiment with CoastSeg using a known dataset without needing to manually fetch and configure it.

Proposed Features

  • Create a new utility script (e.g. download_sample_data.py or coastseg/utils/download_case_study_data.py)
  • Use pooch to download all relevant files for Case Study 1
  • Add appropriate documentation and example usage
  • Integrate this into the documentation/tutorial to help users follow along

Motivation

  • Lower barrier to entry for new users
  • Consistency in how sample data is accessed
  • Enables quick testing and validation of CoastSeg setup

Credit: Idea originally from @dbuscombe-usgs

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status
    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions