Skip to content

Tidying up the Repo - #71

Merged
danielfromearth merged 19 commits into
mainfrom
cleanup
Apr 20, 2026
Merged

Tidying up the Repo#71
danielfromearth merged 19 commits into
mainfrom
cleanup

Conversation

@danielfromearth

@danielfromearth danielfromearth commented Apr 20, 2026

Copy link
Copy Markdown
Collaborator

Tidying up the Repo - maintenance, documentation, and CI improvements

Closes #69

Summary

Assorted housekeeping, CI enhancements, and content reorganization for the ASDC Data & User Services Quarto site.

Changes

CI / Automation

  • Add a PR validation workflow that renders the Quarto site on every PR to main
  • Upload the rendered site as a downloadable artifact (retained 5 days) for reviewer inspection
  • Fix uvx ruff invocation in the lint job
  • Improve notebook-import check hook: suppress SyntaxWarning, add import allowlist, exclude _archive/ directory

Content reorganization

  • Move draft/experimental notebooks (S3-Access-TEMPO-L3_v4, TEMPO_tropNO2_vs_GLM_03) to additional_drafts/
  • Remove unused test_figures/ binary assets
  • Add how_to_visualize_DSCOVR-UVAI notebook to the sidebar

Docs & config

  • Rewrite and improve README.md
  • Update ASDC homepage link → Earthdata.nasa.gov
  • Fix broken relative/external paths and typos across docs
  • Update logo reference in _quarto.yml
  • Expand .gitignore to exclude data files, and notebook files at the top-level
  • Add uv.lock and declare packaging/Pillow dependencies in pyproject.toml

…ck hook

- Filter SyntaxWarnings from ast.parse() caused by invalid escape
  sequences in notebook code (e.g., unescaped Windows paths)
- Add ALLOWLIST for local modules (local_sageiii_plot, tolnet_v01),
  proprietary packages (arcpy), and in-notebook installs (gnss_lib_py)
- Add packaging and Pillow to pyproject.toml as declared dependencies
@danielfromearth danielfromearth self-assigned this Apr 20, 2026
@danielfromearth danielfromearth added documentation Improvements or additions to documentation automation dependencies Pull requests that update a dependency file labels Apr 20, 2026
Add an upload-artifact step to the Quarto render job so reviewers
can download and inspect the rendered site from any pull request.
Artifacts are retained for 5 days. Uses `if: always()` so partial
output is available even when the render step fails.
The sidebar already links to various notebooks that show how to retrieve and examine TEMPO data from S3, using earthacces, harmony-py, and virtual datasets.

Moving this to additional_drafts rather than removing it, because the direct S3 access patterns may be valuable for lower-level control.
@danielfromearth danielfromearth changed the title Cleanup - Tidying up the Repo Apr 20, 2026
@danielfromearth
danielfromearth merged commit 8eb445e into main Apr 20, 2026
4 checks passed
@danielfromearth
danielfromearth deleted the cleanup branch April 20, 2026 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Resolve issues with passing of filenames to pre-commit check-notebook-imports hook

1 participant