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

Add dataset metadata for new E&A to all relevant datasets #317

Merged
merged 14 commits into from
Apr 3, 2024

Conversation

j08lue
Copy link
Collaborator

@j08lue j08lue commented Mar 4, 2024

Closes #303

  1. Add infoDescription blocks for each dataset
  2. Add info blocks for each layer
  3. Add media blocks for each layer

Structured info (info description)

  • casagfed-carbonflux-monthgrid-v3
  • eccodarwin-co2flux-monthgrid-v5
  • gosat-based-ch4budget-yeargrid-v1
  • lpjwsl-wetlandch4-grid-v1
  • oco2-mip-co2budget-yeargrid-v1
  • oco2geos-co2-daygrid-v10r
  • odiac-ffco2-monthgrid-v2022
  • sedac-popdensity-yeargrid5yr-v4.11
  • tm54dvar-ch4flux-monthgrid-v1
  • epa-ch4emission-yeargrid-v2express
  • noaa-cpfp-ch4-point
  • noaa-cpfp-co2-point
  • emit-ch4plume-v1

Structured info (info blocks for each layer)

  • casagfed-carbonflux-monthgrid-v3
  • eccodarwin-co2flux-monthgrid-v5
  • gosat-based-ch4budget-yeargrid-v1
  • lpjwsl-wetlandch4-grid-v1
  • oco2-mip-co2budget-yeargrid-v1
  • oco2geos-co2-daygrid-v10r
  • odiac-ffco2-monthgrid-v2022
  • sedac-popdensity-yeargrid5yr-v4.11
  • tm54dvar-ch4flux-monthgrid-v1
  • epa-ch4emission-yeargrid-v2express
    - [ ] noaa-cpfp-ch4-point
    - [ ] noaa-cpfp-co2-point
    - [ ] emit-ch4plume-v1

Thumbnails

  • casagfed-carbonflux-monthgrid-v3
  • eccodarwin-co2flux-monthgrid-v5
  • gosat-based-ch4budget-yeargrid-v1
  • lpjwsl-wetlandch4-grid-v1
  • oco2-mip-co2budget-yeargrid-v1
  • oco2geos-co2-daygrid-v10r
  • odiac-ffco2-monthgrid-v2022
  • sedac-popdensity-yeargrid5yr-v4.11
  • tm54dvar-ch4flux-monthgrid-v1
  • epa-ch4emission-yeargrid-v2express
    - [ ] noaa-cpfp-ch4-point
    - [ ] noaa-cpfp-co2-point
    - [ ] emit-ch4plume-v1

Copy link

netlify bot commented Mar 4, 2024

Deploy Preview for ghg-demo ready!

Name Link
🔨 Latest commit 12b74c7
🔍 Latest deploy log https://app.netlify.com/sites/ghg-demo/deploys/660d5a2f382fe400088d4112
😎 Deploy Preview https://deploy-preview-317--ghg-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@j08lue j08lue changed the title Add dataset metadata for new E&A Add dataset metadata for new E&A to all relevant datasets Mar 4, 2024
@j08lue j08lue added the good first issue Good for newcomers label Mar 5, 2024
@faustoperez
Copy link

I finished adding the layer thumbnails @j08lue . I didn't update the NOAA + methane ones as they don't load on E&A. Could revisit if needed 👍

@j08lue
Copy link
Collaborator Author

j08lue commented Mar 6, 2024

I didn't update the NOAA + methane ones as they don't load on E&A

Yes, we do not need layer thumbnails for those for now. We can add them later, if need arises.

We will need the structured data, though, please, @siddharth0248, so we can use it in new designs of the Dataset cards in the Data Catalog (https://github.com/US-GHG-Center/ghgc-architecture/issues/133).

@siddharth0248
Copy link

@faustoperez @j08lue I have updated the mdx for all the required files and updated the checkbox list

Copy link
Collaborator Author

@j08lue j08lue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two changes we need to make to the info blocks:

  1. Units should be abbreviated
  2. Information that is not available should be omitted

datasets/casagfed-carbonflux-monthgrid-v3.data.mdx Outdated Show resolved Hide resolved
info:
source: NASA,NOAA
spatialExtent: Global
latency: N/A
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When not available, information should be omitted from this list, rather than set to "N/A".

Copy link

@Jeanne-le-Roux Jeanne-le-Roux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall seems fine to me - I'd like to take a look once everything is in the E&A environment, we may want to adjust a few things based on how it displays. (e.g. we may want to be more concise with how we describe latency for individual data layers)

info:
source: NASA
spatialExtent: Global
latency: Monthly

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note the current latency isn't monthly, but we expect it to be once we receive the next CASA version update

- Spatial Resolution: 1° x 1°
- Data Units: Teragrams of methane per year (Tg CH₄/yr)
- Data Type: Research
- Data Latency: Updated yearly

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For ECCO-Darwin we say "Updated annually" - we should choose one way of wording this for consistency

datasets/oco2-mip-co2budget-yeargrid-v1.data.mdx Outdated Show resolved Hide resolved
@j08lue
Copy link
Collaborator Author

j08lue commented Mar 20, 2024

I'd like to take a look once everything is in the E&A environment

I merged the latest changes here into the preview at #319 - please check it out here: https://deploy-preview-319--ghg-demo.netlify.app/exploration

@Jeanne-le-Roux
Copy link

@j08lue When you click on an info button for a dataset layer, I think it would be more useful to see the temporal resolution on the top line as opposed to the latency. (e.g. in this example "monthly" rather than "approximately 2 years" - what do you think? Was there a justification for choosing latency to go in this position?
image

@j08lue
Copy link
Collaborator Author

j08lue commented Mar 21, 2024

I think it would be more useful to see the temporal resolution on the top line as opposed to the latency

You are right. Sorry that I did not catch that earlier myself. This goes for the dataset card as well as the info page.

Let us please replace this in all the files here - latency -> temporalResolution - and I will make sure it gets updated in VEDA UI as well

@j08lue
Copy link
Collaborator Author

j08lue commented Mar 22, 2024

Let us please replace this in all the files here

Done in the above commit. d54faf2

@j08lue
Copy link
Collaborator Author

j08lue commented Apr 3, 2024

I made the changes we discussed, @Jeanne-le-Roux and @siddharth0248:

  1. Make the list of short info source, spatialExtent, temporalResolution, unit
  2. Replace NASA,NOAA with NASA / NOAA

Can you give it one more look in this preview, please, @Jeanne-le-Roux, and confirm that it is ready to go out (when we launch E&A)?

https://deploy-preview-319--ghg-demo.netlify.app/

@Jeanne-le-Roux
Copy link

@j08lue I think this looks good. One more thing - right now the unique layer descriptions are only displayed when you are presented with layers to select, but when you click on the info button for a layer in the explore environment that short layer description doesn't seem to be there. This is something that we need to make sure is visible somewhere.
layer_descr
layer_info

@j08lue
Copy link
Collaborator Author

j08lue commented Apr 3, 2024

Thanks, @Jeanne-le-Roux, I'll merge this PR then, to avoid more merge conflicts. Since the changes are backwards-compatible, there should be no issue in merging them already now, before the release of E&A.

I ticketed your suggestion for adding the layer description to the info modal - should be a quick fix.

@j08lue j08lue merged commit 05d3311 into develop Apr 3, 2024
5 checks passed
@j08lue j08lue deleted the ena-dataset-metadata branch April 3, 2024 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[E & A] Add dataset markdown and layer structured data to all GHG datasets for E&A
4 participants