Skip to content

Commit ff95946

Browse files
authored
Merge pull request #3 from jukent/doi
Doi infrastructure changes
2 parents 4c454cd + 991d947 commit ff95946

File tree

6 files changed

+39
-19
lines changed

6 files changed

+39
-19
lines changed

CITATION.cff

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
cff-version: 1.2.0
2+
message: "If you use this cookbook, please cite it as below."
3+
authors:
4+
# add additional entries for each author -- see https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
5+
- family-names: Camron
6+
given-names: Drew
7+
orcid: https://orcid.org/0000-0001-7246-6502
8+
website: https://github.com/dcamron
9+
affiliation: UCAR/Unidata
10+
- name: "Metpy Cookbook contributors" # use the 'name' field to acknowledge organizations
11+
website: "https://github.com/ProjectPythia/metpy-cookbook/graphs/contributors"
12+
title: "Metpy Cookbook"
13+
abstract: "A sample cookbook description."

README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
</div>
88
</div>
99

10-
1110
**:warning: THIS COOKBOOK IS UNDER CONSTRUCTION :warning:**
1211

1312
# MetPy Cookbook
1413

1514
[![nightly-build](https://github.com/ProjectPythia/metpy-cookbook/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/metpy-cookbook/actions/workflows/nightly-build.yaml)
1615
[![Binder](http://binder.projectpythia.org/badge_logo.svg)](http://binder.projectpythia.org/v2/gh/ProjectPythia/metpy-cookbook/main?labpath=notebooks)
16+
[![DOI](https://zenodo.org/badge/620944317.svg)](https://zenodo.org/badge/latestdoi/620944317)
1717

1818
This Cookbook is the oversized recipe book for all your MetPy needs.
1919
We provide a gallery of real workflows centered around meteorological data,
@@ -34,7 +34,6 @@ MetPy Maintainers and the MetPy Community.
3434

3535
### The MetPy Example Gallery
3636

37-
3837
## Running the Notebooks
3938

4039
You can either run the notebook using [Binder](https://mybinder.org/) or on your local machine.

_config.yml

+1-14
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,6 @@ logo: pythia.png
77
88
copyright: "2024"
99

10-
description: A sample cookbook description.
11-
thumbnail: metpy.png
12-
tags:
13-
domains:
14-
- meteorology
15-
- data access
16-
packages:
17-
- metpy
18-
- siphon
19-
- cartopy
20-
- xarray
21-
- pint
22-
2310
execute:
2411
# To execute notebooks via a binder instead, replace 'cache' with 'binder'
2512
execute_notebooks: cache
@@ -50,7 +37,7 @@ sphinx:
5037
html_permalinks_icon: '<i class="fas fa-link"></i>'
5138
html_theme_options:
5239
home_page_in_toc: true
53-
repository_url: https://github.com/ProjectPythia/cookbook-template/ # Online location of your book
40+
repository_url: https://github.com/ProjectPythia/metpy-cookbook/ # Online location of your book
5441
repository_branch: main # Which branch of the repository should be used when creating links (optional)
5542
use_issues_button: true
5643
use_repository_button: true

_gallery_info.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
thumbnail: metpy.png
2+
tags:
3+
domains:
4+
- meteorology
5+
- data access
6+
packages:
7+
- metpy
8+
- siphon
9+
- cartopy
10+
- xarray
11+
- pint

_toc.yml

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
format: jb-book
22
root: README
33
parts:
4+
- caption: Preamble
5+
chapters:
6+
- file: notebooks/how-to-cite
47
- caption: The MetPy Gallery
58
chapters:
69
- file: notebooks/notebook-template
7-
title: What organization
10+
title: What organization
811
sections:
9-
- glob: notebooks/gallery/*
12+
- glob: notebooks/gallery/*
1013
- file: notebooks/gallery/index1
1114
title: do we want
1215
- file: notebooks/gallery/index2
@@ -20,4 +23,4 @@ parts:
2023
- file: notebooks/Skew-T_Analysis
2124
- file: notebooks/Sounding_LCL_Dataset
2225
- file: notebooks/Sounding_Plotter
23-
- file: notebooks/Sounding_Calculations
26+
- file: notebooks/Sounding_Calculations

notebooks/how-to-cite

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# How to Cite This Cookbook
2+
3+
The material in Project Pythia's Metpy Cookbook 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.
4+
5+
The source code for the book is [released on GitHub](https://github.com/ProjectPythia/metpy-cookbook) and archived on Zenodo. This DOI will always resolve to the latest release of the book source:
6+
7+
[![DOI](https://zenodo.org/badge/620944317.svg)](https://zenodo.org/badge/latestdoi/620944317)

0 commit comments

Comments
 (0)