Ribbit-Network/ribbit-network-faq

Data documentation

Closed this issue · 5 comments

spestana commented

I am going to start a guide (or guides) about the data that the ribbit network collects. Opening an issue here in the faq repo since that seemed like a good place to start.

This guide could cover things such as (but not limited to):

  • details about how the measurements are made
  • how the auto-calibration is performed
  • caveats about instrument accuracy
  • how to interpret the data

I see this as serving a few different purposes (and maybe more than one guide is needed to cover these):

  • a readme or metadata about ribbit network data, sample code, research ideas
  • caveats about instrument accuracy
  • some of the science of measuring CO2 (NDIR, plus atmospheric corrections with temperature and pressure)
  • "why does the data look like X"? some explanations about what the data might typically look like (could also help spot data errors, odd sensor placement)

This could eventually be part of a wiki, live alongside the faq, and maybe would be nice to see as a readme on the dashboard or main website.

keenanjohnson commented

Sounds great! That would be a real improvement to the documentation!

keenanjohnson commented

@all-contributors please add @spestana for their awesome improvements to the data documentation!

keenanjohnson commented

@spestana do you think this is done enough for now to close and create individual issues for new things?

spestana commented

@spestana do you think this is done enough for now to close and create individual issues for new things?

yes, sounds good!

  • 👍1