Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

initial doc commit #139

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

initial doc commit #139

wants to merge 1 commit into from

Conversation

jhamman
Copy link

@jhamman jhamman commented Jan 5, 2022

This PR adds project documentation to this repo. There are four main doc types with the following planned pages:

TUTORIALS

  • Quick start (install trace package and explore data/models) (@jhamman writes first draft, @orianac reviews)

HOW-TO Guides

  • Run the v0 workflow (@jhamman writes first draft, @orianac reviews)
  • run the viirs fire mask workflow (@jhamman writes first draft, @orianac reviews)
  • V1 steps (@orianac writes first draft, @tcchiao reviews)
    • process glas data
    • generate biomass training data
    • train biomass model
    • run biomass inference
    • post-process biomass predictions

Conceptual Guides

  • forest emissions (motivation / overview)
  • v0 method description (done for climatetrace)
  • v1 method description (done for climatetrace)
  • wishlist / roadmap / cookbook

Reference

Most docs are currently blank. As we add content, let's check off the boxes above.

@freeman-lab / @katamartin - as the content evolves here, we'll want some help setting up the doc site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant