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

Document science data products and product metadata #34

Open
lewismc opened this issue Oct 21, 2017 · 2 comments
Open

Document science data products and product metadata #34

lewismc opened this issue Oct 21, 2017 · 2 comments

Comments

@lewismc
Copy link
Member

lewismc commented Oct 21, 2017

Once we have addressed capstone-coal/pycoal#118 we should really think about documenting the science data products in a formal way such that consumers are crystal clear on what to expect and how to process.

@ghost
Copy link

ghost commented Oct 23, 2017

Agreed. Let me know if you need any feedback on the data formats that were used. Small details like the unsigned 16-bit integer data type that were chosen for the environmental correlation output. I have complained a lot about libraries that make you dig into the source code to figure out what is going on, so I don't want to add to the problem!

It would also be helpful to document more clearly what happens during each processing stage. As I review the capstone materials for the AGU presentations I am coming across the sketches and outlines we shared. More polished and up-to-date versions of these could be used to explain the algorithm in a visual way. I suppose that informal documentation is the opposite of what you created this issue for, so another could be created for that.

There is also Issue #28 on documenting our San Juan case study which is not currently detailed on the website.

@lewismc
Copy link
Member Author

lewismc commented Oct 24, 2017

Once we have all of this material together (hopefully before Christmas time) I'll begin working on our next publication which will significantly expand upon the BiDS'17 paper and which we will submit for blind peer reviewed journal publication.

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

No branches or pull requests

1 participant