Skip to content

Commit

Permalink
Merge pull request #125 from jukent/main
Browse files Browse the repository at this point in the history
changes based on DOI infrastructure
  • Loading branch information
brian-rose committed Jun 22, 2023
2 parents 3c521ae + 6038a36 commit 297e44e
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 9 deletions.
48 changes: 48 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
cff-version: 1.2.0
message: "If you use this cookbook, please cite it as below."
authors:
# add additional entries for each author -- see https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
- family-names: Rose
given-names: Brian E. J.
orcid: https://orcid.org/0000-0002-9961-3821 # optional
website: https://github.com/brian-rose # optional
affiliation: University at Albany (State University of New York) # optional
- family-names: Kent
given-names: Julia
orcid: https://orcid.org/0000-0002-5611-8986
website: https://github.com/jukent
affiliation: UCAR/NCAR
- family-names: Tyle
given-names: Kevin
orcid: https://orcid.org/0000-0001-5249-9665
website: https://github.com/ktyle
affiliation: University at Albany (State University of New York)
- family-names: Clyne
given-names: John
orcid: https://orcid.org/0000-0003-2788-9017
website: https://github.com/clyne
affiliation: UCAR/NCAR
- family-names: Camron
given-names: Drew
orcid: https://orcid.org/0000-0001-7246-6502
website: https://github.com/dcamron
affiliation: UCAR/Unidata
- family-names: Grover
given-names: Maxwell
orcid: https://orcid.org/0000-0002-0370-8974
website: https://github.com/mgrover1
affiliation: Argonne National Laboratory
- family-names: Ford
given-names: Robert R.
orcid: https://orcid.org/0000-0001-5483-4965
website: https://github.com/r-ford
affiliation: University at Albany (State University of New York)
- family-names: Paul
given-names: Kevin
orcid: https://orcid.org/0000-0001-8155-8038
website: https://github.com/kmpaul
affiliation: NVIDIA
- name: "Cookbook Template contributors" # use the 'name' field to acknowledge organizations
website: "https://github.com/ProjectPythia/cookbook-template/graphs/contributors"
title: "HRRR AWS Cookbook"
abstract: "A sample cookbook description."
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

[![nightly-build](https://github.com/ProjectPythia/cookbook-template/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/cookbook-template/actions/workflows/nightly-build.yaml)
[![Binder](https://binder.projectpythia.org/badge_logo.svg)](https://binder.projectpythia.org/v2/gh/ProjectPythia/cookbook-template/main?labpath=notebooks)
[![DOI](https://zenodo.org/badge/475509405.svg)](https://zenodo.org/badge/latestdoi/475509405)

This Project Pythia Cookbook covers ... (replace `...` with the main subject of your cookbook ... e.g., _working with radar data in Python_)

Expand Down
9 changes: 0 additions & 9 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,8 @@
title: Project Pythia Cookbook Template
author: the <a href="https://projectpythia.org/">Project Pythia</a> Community
logo: notebooks/images/logos/pythia_logo-white-rtext.svg
email: projectpythia@ucar.edu
copyright: "2023"

description: A sample cookbook description.
thumbnail: thumbnail.png
tags:
domains:
- sampledomain
packages:
- samplepackage

execute:
# To execute notebooks via a Binder instead, replace 'cache' with 'binder'
execute_notebooks: cache
Expand Down
6 changes: 6 additions & 0 deletions _gallery_info.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
thumbnail: thumbnail.png
tags:
domains:
- sampledomain
packages:
- samplepackage
3 changes: 3 additions & 0 deletions _toc.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
format: jb-book
root: README
parts:
- caption: Preamble
chapters:
- file: notebooks/how-to-cite
- caption: Introduction
chapters:
- file: notebooks/notebook-template
7 changes: 7 additions & 0 deletions notebooks/how-to-cite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# How to Cite This Cookbook

The material in Project Pythia's [Cookbook Template] is licensed for free and open consumption and reuse. All code is served under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0), while all non-code content is licensed under [Creative Commons BY 4.0 (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/). Effectively, this means you are free to share and adapt this material so long as you give appropriate credit to the Cookbook authors and the Project Pythia community.

The source code for the book is [released on GitHub](https://github.com/ProjectPythia/cookbook-template) and archived on Zenodo. This DOI will always resolve to the latest release of the book source:

[![DOI](https://zenodo.org/badge/475509405.svg)](https://zenodo.org/badge/latestdoi/475509405)

0 comments on commit 297e44e

Please sign in to comment.