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

New Task: Release v1.0 of ATN DAC netCDF **profile** template #57

Open
4 tasks
MathewBiddle opened this issue May 2, 2024 · 7 comments
Open
4 tasks
Assignees
Labels
ATN Issues relating to the Animal Telemetry Network enhancement New feature or request

Comments

@MathewBiddle
Copy link
Contributor

MathewBiddle commented May 2, 2024

Who is requesting this?

@ioos/marine-life and NCEI

What is being requested?

ATN establishes a netCDF template for profile data. This includes:

  • Draft the netCDF template following the contributing guidelines published from Add contributing guidelines ioos-atn-data#79
  • Present to IOOS DMAC for review and approval.
  • Present netCDF template to NCEI for approval (maybe needs NCEI Dataset Readiness Review (DSRR) board approval?)

What is the requested deadline and why?

2024-12-31

What is the current status quo (i.e., what happens if this does not get done)?

NCEI will not archive data that aren't fully documented. The telemetry community will splinter into multiple file templates for similar observing methods.

What indicates this is done (i.e., how do we know this is complete)?

Provide a description or any other important information.

xref:

Split from:

@MathewBiddle
Copy link
Contributor Author

This should build heavily on the work done for satellite trajectory work. So, we don't expect this to be a significant lift, but may take time to get to.

@mmckinzie
Copy link

Agreed. We're still working on finalizing the related trajectory template and pushing relevant updates to the ATN satellite telemetry [specification v.1 website] (https://ioos.github.io/ioos-atn-data/atn-sat-telem-specification-v1-0.html). There are also some lingering issues to resolve regarding select global attributes (e.g., :Acknowledgements, :sea names) within the files themselves and related to corresponding metadata harvesting/generation by NCEI. Once everything within the trajectory template is finalized and aligns with NCEI documentation, we'll move on to the profile template specification documentation, website integration and NCEI approval. Axiom also still needs to work on automating and operationalizing the NCEI pipeline.

@mmckinzie mmckinzie added the enhancement New feature or request label Jul 11, 2024
@MathewBiddle
Copy link
Contributor Author

MathewBiddle commented Jul 31, 2024

@mmckinzie I think you, @laurabrenskelle, and I can come up with what the template should look like and hand that over to Axiom to implement. The goal of this issue is to establish what the template will look like.

I am going to set a relatively aggressive timeline of having the first version of the template released by the end of the calendar year (Dec 31st). I think it's doable as we've already done a lot of the heavy lifting on the trajectory template.

@mmckinzie
Copy link

@MathewBiddle its more or less already done. No need to come up with one. We just haven't passed it off to Axiom because we're still trying to resolve issues with the trajectory template

@MathewBiddle
Copy link
Contributor Author

We need to be clear on what means done in this case.

My definition of done is a .cdl file that is added to https://github.com/ioos/ioos-atn-data/tree/gh-pages/_docs/data/templates which clearly defines what the netCDF file will look like for the profile data. That should be the "thing" that is passed off to Axiom for implementation.

Additionally, the documentation page (https://ioos.github.io/ioos-atn-data/) should be updated to clearly describe the specification. Similar to the trajectory page https://ioos.github.io/ioos-atn-data/atn-sat-telem-specification-v1-0.html.

We might need to rethink how the webpage is organized or named to be clear about which template is which.

@MathewBiddle
Copy link
Contributor Author

See my update to the contributing guide for details. https://github.com/ioos/ioos-atn-data/blob/gh-pages/CONTRIBUTING.md#file-template-development

@mmckinzie
Copy link

Fair enough. We are not yet to the point where a .cdl file could be generated and added the ioos-atn-data github nor shared with Axiom and I agree that eventually the documentation page should be updated to describe specification and yes, I'd appreciate your help generating the cdl file.

I have been working on generating a 'template' that could be used as the basis the generate the .cdl file and provide context to specification on website which includes the complete list of global attributes including their scope/source convention, disposition, content source, example and descriptions, and a list of variables and their associated attributes, values, source and examples for both WC and SMRU.

I only have the global attributes finalize, still working on adding the variables. That file is available here. Please do not share this file publicly as it contains embargoed/protected information.

@MathewBiddle MathewBiddle changed the title New Task: Release v1.0 of ATN DAC netCDF profile template New Task: Release v1.0 of ATN DAC netCDF **profile** template Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ATN Issues relating to the Animal Telemetry Network enhancement New feature or request
Projects
Status: ToDo
Development

No branches or pull requests

3 participants