Waterhackweek Repository Tutorial & Project Citations

[ChristinaB]

How to make your Waterhackweek Github Repository citable

Do you have time to step through this tutorial? Making Your Code Citable. If so, can you let me know how much time it takes? Any hangups or questions? Here is an example that I have from implementing these steps for code that is part of a journal article.

[ChristinaB]

Steps for Publications with Data and Code References

1. First make Readme in Github with links to data and journal, get Zenodo code DOI for first release.
2. Crosspost on data repository (draft/temp) if the data is too big for Github or there is a community data repository for sharing.
3. Submit to journal, edit, get final DOI for journal publication.
4. Update Readme's on Github and Data repository (e.g. HydroShare) with the same final Readme with final article details and DOI.
5. Get second release on Github.
6. (Optional) Get a binder badge or other JupyterHub link.
7. Notify the world.
8. Share the Notebooks with a computing resource community to get support curating the software environment and keeping hyperlinks up to date.
9. Notify more of the world.
10. Keep doing amazing work.

++ Repeat 1-10. Synthesize. Build. Version.
++ Teach the world. Cite the world.

[ChristinaB]

Make it easier to cite your contributions to your community.

We measure what we care about - sharing! reproducing!

Row headers	Amazing Contributions
GithubUserID	@ChristinaB
WHW_ID (2019, 2020, 2021, open)	2020
Time spent on First Github DOI (min)	60
Average time on Github-Zenodo DOI (min)	10
Roadblocks, Issues, Dilemmas	Low coauthor awareness, license choice
Tips, Tricks, Notes	Do it every time.
DOI list for public reporting	Version v0.0.1-alpha 10.5281/zenodo.3239539

[ChristinaB]

Template for quantifying the time savings and share-ability of contributing to and using Waterhackweek Learning Resources:

Row headers	Amazing Contributions
GithubUserID
WHW_ID (2019, 2020, 2021, open)
Time spent on First Github DOI (min)
Average time on Github-Zenodo DOI (min)
Roadblocks, Issues, Dilemmas
Tips, Tricks, Notes
DOI list for public reporting

[ChristinaB]

@YifanCheng Can you let me know if this makes sense? We don't want to ask tutorial leads to do too much extra work, and we want to be data driven about knowing the value of your time and tracking your contributions. Thanks again for your tutorial!!

[emiliom]

Do you have time to step through this tutorial?

Who is "you"? I thought it'd be me, but based on your last comment it looks like it's @YifanCheng . Anyway, I don't have time myself.

[ChristinaB]

Correct - in #canaryopera Philip Murphy and I are discussing with @YifanCheng how to cite a tutorial or project so it can be reused and this is my copy of the instructions to create this citation:

How to cite a Waterhackweek Github Repository

###Code template citation simplified:
Amazing A. , B. Beautiful, C. Code. (YYYY, Month X). https://github.com/waterhackweek/repositoryname: Alpha release to create DOI for Waterhackweek (Version v0.0.1-alpha). Zenodo. http://doi.org/10.####/zenodo.#######

To Do list:

• Readme.md expectations - e.g. where does this run? coauthors? contributors? data resource hyperlinks, team and organizer references. Copy/paste abstracts and readme's so versions cross posted in HydroShare are intentionally tagged to be consistent, or intentionally labeled as different versions.
• Please contact waterhackweek@uw.edu with your DOI so we can list with Waterhackweek ORCID - 0000-0001-7733-7419
• Please include 'Waterhackweek Learning Community' as coauthors or acknowledgements based on contributions. For example, AGU & EGU abstracts have coauthor options of listing a 'Team' as a coauthor.

[ChristinaB]

Instructions on How to Cite and Reuse this Tutorial:

1. modify the example above specific to your notebook
   Amazing A. , B. Beautiful, C. Code. (YYYY, Month X). https://github.com/waterhackweek/repositoryname: Alpha release to create DOI for Waterhackweek (Version v0.0.1-alpha). Zenodo. http://doi.org/10.####/zenodo.#######

Amazing Notebook Author. , B. Beautiful, C. Code Contributors... (YYYY, Month X). https://github.com/waterhackweek/repositoryname/Notebook name: Alpha release to create DOI for Waterhackweek (Version v0.0.1-alpha). Zenodo. http://doi.org/10.####/zenodo.#######

2. Then see To Do list above
   Waterhackweek Repository Tutorial & Project Citations  #23

3. Cite the cyberinfrastructure - Tony Castronova he needs to get a DOI for cuahsi-stacks. Forked from CUAHSI/cuahsi-stacksThis is a compilation of docker images that follow the SPEC pattern.

[ChristinaB]

For March 2021 we can have a version of the Landlab citation registry running and the output will be input for the Connector graph we will use to update the Tableau and Freshwater figures of the community impacts. Thanks for contributing to the workflow! Let's keep it as easy and functional as possible with this bibtex format in mind. Link to the demonstration Waterhackweek 2019 visualization on the University of Washington Freshwater website. To run the python code or explore the visualization with NetworkX, click on the badge to launch the Binder software environment. . Note - another tool for trackable contributions is how we have all-contributors in the Connector repository.