Added policies (#89)

docs/products/tools/Policies/Policies.md

@@ -0,0 +1,42 @@
+# CIROH Data and Code Sharing Policy and Guidance
+
+## Abstract
+The Cooperative Institute for Research to Operations in Hydrology (CIROH) is committed to an open data policy that will maximize the impact and broad use of data and research products produced by CIROH projects and will also ensure that Federal data sharing requirements are met. This policy document is intended to assist CIROH investigators in creating and sharing high-quality data and research products. We begin with guiding principles, after which the specific policy and recommendations are stated. This document also provides guidance and instructions that may be useful to CIROH investigators in meeting the terms of this policy. Finally, we also include an appendix with further details about the specific data sharing requirements of CIROH’s partner agencies. We consider this policy to be a living document that will be revised as the needs of CIROH investigators and CIROH partner agencies evolve.
+
+## Guiding Principles
+We provide the following principles that guide CIROH’s activities and associated data sharing:
+- Science is reproducible.
+- Reproducibility of scientific work is enabled through openness.
+- Open science is enabled through open access to data, source code, accessible computational resources, and sufficient metadata for interpretation/use.
+- Products of CIROH research are produced at public expense and should be broadly accessible to the public.
+
+## Policy Statement
+CIROH follows NOAA’s Data Sharing Directive, which is included in the Terms and Conditions of CIROH’s Cooperative Agreement with NOAA and is also available [here](https://nosc.noaa.gov/EDMC/PD.DSP.php) (Version 3.0 at the time of this writing). CIROH is responsible for implementing these conditions and ensuring that they are also met by CIROH sub-recipients and subcontractors. The Data Management Plan submitted with the original CIROH proposal is included as Appendix ?? to this document.
+
+The specific wording included in the CIROH Cooperative Agreement is as follows:
+
+- **Data Sharing:** Environmental data collected or created under this Grant, Cooperative Agreement, or Contract must be made publicly visible and accessible in a timely manner, free of charge or at minimal cost that is no more than the cost of distribution to the user, except where limited by law, regulation, policy, or national security requirements. Data are to be made available in a form that would permit further analysis or reuse: data must be encoded in a machine-readable format, preferably using existing open format standards; data must be sufficiently documented, preferably using open metadata standards, to enable users to independently read and understand the data. The location (internet address) of the data should be included in the final report. Pursuant to NOAA Information Quality Guidelines, data should undergo quality control (QC), and a description of the QC process and results should be referenced in the metadata.
+- **Timeliness:** Data accessibility must occur no later than publication of a peer-reviewed article based on the data, or two years after the data are collected and verified, or two years after the original end date of the grant (not including any extensions or follow-on funding), whichever is soonest unless a delay has been authorized by the NOAA funding program.
+- **Disclaimer:** Data produced under this award and made available to the public must be accompanied by the following statement: "These data and related items of information have not been formally disseminated by NOAA, and do not represent any agency determination, view, or policy."
+- **Failure to Share Data:** Failing or delaying to make environmental data accessible in accordance with the submitted Data Management Plan, unless authorized by the NOAA Program, may lead to enforcement actions and will be considered by NOAA when making future award decisions. Funding recipients are responsible for ensuring these conditions are also met by sub-recipients and subcontractors.
+- **Funding acknowledgment:** Federal funding sources shall be identified in all scholarly publications. An Acknowledgements section shall be included in the body of the publication stating the relevant Grant Programs and Award Numbers. In addition, funding sources shall be reported during the publication submission process using the FundRef mechanism (http://www.crossref.org/fundref/) if supported by the Publisher.
+- **Manuscript submission:** The final pre-publication manuscripts of scholarly publications produced with NOAA funding shall be submitted to the NOAA Institutional Repository at http://library.noaa.gov/repository after acceptance and no later than upon publication of the paper by a journal. NOAA will produce a publicly-visible catalog entry directing users to the published version of the article. After an embargo period of one year after publication, NOAA shall make the manuscript itself publicly visible, free of charge, while continuing to direct users to the published version of record.
+- **Data Citation:** Publications based on data, and new products derived from source data, must cite the data used according to the conventions of the Publisher, using unambiguous labels such as Digital Object Identifiers (DOIs). All data and derived products that are used to support the conclusions of a peer-reviewed publication must be made available in a form that permits verification and reproducibility of the results.
+
+## Important Definitions
+
+There are several definitions in NOAA’s Data and Publication Sharing Directive that we provide here for interpretation of the above text. For the full list and for the exact statement of these definitions, refer to the full text of NOAA’s Data Sharing Directive (Version 3.0) at the link in the section above.
+
+1. **Research Results:** Defined as environmental data and peer-reviewed publications under NOAA’s Data Sharing Directive.
+2. **Environmental Data:** Defined by NOAA Administrative Order (NAO) 212-15 as:
+   - Recorded and derived observations and measurements of:
+     - Physical, chemical, biological, geological, and geophysical properties and conditions of:
+       - Oceans, atmosphere, space environment, sun, and solid earth.
+        - Correlative data such as socio-economic data, related documentation, and metadata.
+   - Includes digital audio or video recordings of environmental phenomena and numerical model outputs used to support peer-reviewed publications.
+   - Data collected in a laboratory or other controlled environment, including measurements of animals and chemical processes.
+3. **Data Sharing Directive:** Defines "data" specifically as environmental data.
+4. **Sharing Data:** Making data publicly visible and accessible in a timely manner at no cost or minimal cost, in a machine-readable format based on open standards, along with necessary metadata.
+5. **Timeliness:** Data accessibility must occur no later than publication of a peer-reviewed article based on the data or within two years of data collection or grant end date, whichever is soonest, unless authorized delay by NOAA.
+6. **Applicability:** Applies to new data created by extramural funding recipients; internally produced NOAA data or collaborative research data are subject to the NOAA Data Access Directive.
+7. **Exclusions:** Laboratory notebooks, preliminary analyses, drafts of scientific papers, plans for future research, peer review reports, communications with colleagues, or physical objects are not covered under NOAA’s Data Sharing Directive.

docs/products/tools/Policies/Recommendations.md

@@ -0,0 +1,117 @@
+# Recommendations for Meeting CIROH’s Data and Code Sharing Policy
+
+In the following sections, we provide some practical guidance for CIROH researchers designed to help them meet the terms and conditions of CIROH’s Data and Code Sharing Policy, as discussed above, for different types of research products. Each section is focused on providing guidance for a particular type of product, but these sections may not be inclusive of all of the types of products that may fall under NOAA’s requirements for sharing data and research products.
+
+## Recommendations for Sharing Data
+
+Depending on the type and size of data you are producing and using, we recommend the following options for data archiving and sharing data:
+
+1. **HydroShare (www.hydroshare.org)**
+   - **When to use:**
+     - Use for datasets under 1GB (increases are possible)
+     - Datasets that require spatial data services (THREDDS, WMS, etc)
+     - Datasets that need to be accessed from applications through APIs
+     - Datasets that are linked to other datasets
+     - Datasets that require formal publishing with a DOI
+     - For links and pointers to external datasets
+     - Consider using a Creative Commons License for releasing data
+   - **When not to use:**
+     - Very large datasets
+     - Rapidly changing datasets
+     - Data with extensive sharing and license restrictions
+   - **Cost of use:**
+     - Free for researchers up to 20 GB per user
+     - Free for permanently published data
+   - **Where to go for help:** 
+     - [HydroShare Help](http://help.hydroshare.org)
+     - Email [email protected] to reach the CUAHSI HydroShare team
+     - HydroShare short videos on CUAHSI YouTube channel
+
+2. **CIROH Cloud Amazon S3 storage via CIROH’s AWS account and Google Buckets, Azure, On-Premise**
+   - **When to use:**
+     - Use for large datasets
+     - Data that is part of the NWM workflows (https://console.cloud.google.com/storage/browser/national-water-model)
+     - Cloud computing linked data
+     - Consider linking to cloud share from HydroShare for discoverability
+   - **When not to use:**
+     - Smaller datasets you want to formally publish with a DOI (May complicate formal publication with DOI)
+   - **Cost of use:**
+     - Some uses may be covered by CIROH core funds (contact CIROH Cloud Team to start a request)
+     - Extensive uses may be charged to individual CIROH projects
+   - **Where to go for help:**
+     - Email [email protected] UA CIROH Cloud Team
+     - CIROH Cloud Slack Channel - #ciroh-ua-it-admin
+     - AWS support Slack Channel - #aws-ciroh-support
+
+3. **Water Prediction Node: https://waternode.ciroh.org/**
+   - **Who to contact for help:** Water Prediction Node Team
+     - CIROH side: Dylan Lee (CoastWatch Water Node Coordinator), [email protected]
+
+## Recommendations for Sharing Code
+
+1. **GitHub (www.github.org)**
+   - **When to use:**
+     - Generally post your code on your institution’s GitHub organization - some projects may be appropriately hosted on CIROH organization
+     - We suggest forking the CIROH template for structured readme files, etc.
+     - Example: https://github.com/NOAA-OWP/owp-open-source-project-template
+     - When multiple developers are actively developing software or other products
+     - Consider using the three clause BSD3 or MIT license
+     - Consider linking to Zenodo to snapshot and get a DOI for your code
+   - **When not to use:**
+     - Not recommended for proprietary code (although private repositories are available in GitHub at cost)
+   - **Cost of use:**
+     - Free for public repositories
+     - Cost for private repositories
+   - **Where to go for help:**
+     - GitHub discussion forums
+     - CIROH Slack channels e.g., #ciroh-hydroinformatics-working-group
+
+2. **Jupyter notebooks in HydroShare**
+   - **When to use:**
+     - Sharing code as Jupyter notebooks that you want to be launchable into a computational environment like CIROH JupyterHub
+     - When you want your code to accompany data in one citable resource for reproducibility purposes
+   - **When not to use:**
+     - When code is rapidly changing
+     - When you want your code to be under formal version control
+   - **Cost of use:**
+     - Free for researchers to store up to 20 GB of content in HydroShare
+     - CUAHSI JupyterHub is free to use
+     - CIROH 2i2c JupyterHub is free to use
+   - **Where to go for help:**
+     - Email [email protected] for help with sharing notebooks in HydroShare and/or launching notebooks into the CUAHSI JupyterHub instance
+     - How to get access to CIROH 2i2c: https://docs.ciroh.org/docs/services/cloudservices/google/
+     - How to get access to 2i2c using Hydroshare: https://docs.ciroh.org/docs/services/cloudservices/google/hydroshareintegration
+
+## Recommendations for Sharing Models
+
+Model sharing can be viewed as “code sharing” or “data sharing,” and many of the suggested methods above can be adopted for model sharing. Consider the following options for sharing models:
+
+- GitHub - Supports sharing of model source codes
+- HydroShare - Supports sharing of model programs and models instances
+- NextGen in a Box (NGIAB) - Use cloud computing to modify and execute NextGen based models in a docker container
+- CIROH Web Sites - Downloadable executables, model instances, installers, etc can be shared on the CIROH portal web site.
+
+## Recommendations for Sharing Workflows
+
+- GitHub
+- JupyterNotebooks in HydroShare - launch into CIROH JupyterHub environment or CUAHSI JupyterHub
+
+## Recommendations for Sharing Published Manuscripts
+
+- GitHub (see https://github.com/NOAA-OWP/OWP-Presentations)
+- Per NOAA - Don’t share preprints prior to peer review
+
+## Recommendations for Sharing Educational Materials
+
+- HydroLearn - We recommend using www.HydroLearn.org which allows for and supports the following types of learning module sharing, education,
+  - **When to use:**
+    - Broadly applicable learning modules related to hydrology and NWM
+  - **When not to use:**
+    - Highly specific, localized, tailored learning materials for your specific university or departmental courses
+    - Material that requires specific and inaccessible data, software, etc.
+  - **Cost to use:**
+    - Free for open access learning modules
+  - **Where to go for help:**
+    - [HydroLearn Contact Us](https://www.hydrolearn.org/contact-us/)
+    - Use other tools intentionally if they meet a need e.g. Norm Jones at BYU GitHub gists as educational python modules to show how to use certain modules.
+    - You can also use the CIROH educational portal to share your tutorials and guideline materials at https://docs.ciroh.org/docs/education/