https://github.com/gusellerm/coastsat-shorelinepublication

Generate interactive, reproducible research publications from CoastSat shoreline analysis data. Features dynamic documents with executable code and RO-Crate metadata standards. See an example linked via git-pages.
https://github.com/gusellerm/coastsat-shorelinepublication

coastal-dynamics dynamic-documents dynamic-narrative-framework reproducible-research research-publications ro-crate shoreline-change-analysis stencila

Last synced: 5 months ago
JSON representation

Generate interactive, reproducible research publications from CoastSat shoreline analysis data. Features dynamic documents with executable code and RO-Crate metadata standards. See an example linked via git-pages.

• Host: GitHub
• URL: https://github.com/gusellerm/coastsat-shorelinepublication
• Owner: GusEllerm
• License: cc-by-4.0
• Created: 2025-07-21T23:40:08.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2026-01-14T23:23:35.000Z (5 months ago)
• Last Synced: 2026-01-15T05:40:30.525Z (5 months ago)
• Topics: coastal-dynamics, dynamic-documents, dynamic-narrative-framework, reproducible-research, research-publications, ro-crate, shoreline-change-analysis, stencila
• Language: HTML
• Homepage: https://gusellerm.github.io/CoastSat-shorelinepublication/
• Size: 58.1 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff
  • Codemeta: codemeta.json
  • Zenodo: .zenodo.json

Awesome Lists containing this project

README

          
# CoastSat shoreline LivePublication [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18250456.svg)](https://doi.org/10.5281/zenodo.18250456)

## What this is

This repository is a CoastSat shoreline LivePublication container: an executable, reproducible publication that combines narrative text, computational steps, and generated artefacts. It is designed as a publishable research object (Chapter 6 case study). The repository supports RO-Crate packaging and Stencila-based rendering to make the publication portable and inspectable.

## What it contains

- Narrative sources (Stencila Markdown) in `src/templates/shoreline_publication.smd` and generated instances in `docs/`.

- Build and render scripts in `src/` and `scripts/` for publication creation and GitHub Pages deployment.

## How to view / run

- Live preview: https://gusellerm.github.io/CoastSat-shorelinepublication/

- View this publication in its native environement within the CoastSat dashboard: https://coastsat.livepublication.org/

- Generate a publication locally:

  - `python src/publication_logic.py aus0001`

  - `python src/publication_logic.py aus0001 --populate-crate`

## Inputs & provenance

- interface.crate generation tool (Zenodo): https://doi.org/10.5281/zenodo.18250232

## How to cite

Use `CITATION.cff`. Zenodo DOI: https://doi.org/10.5281/zenodo.18250456

## License

CC BY 4.0 (see `LICENSE`).