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

Doi infrastructure changes #3

Merged
merged 3 commits into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
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: Camron
given-names: Drew
orcid: https://orcid.org/0000-0001-7246-6502
website: https://github.com/dcamron
affiliation: UCAR/Unidata
- name: "Metpy Cookbook contributors" # use the 'name' field to acknowledge organizations
website: "https://github.com/ProjectPythia/metpy-cookbook/graphs/contributors"
title: "Metpy Cookbook"
abstract: "A sample cookbook description."
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
</div>
</div>


**:warning: THIS COOKBOOK IS UNDER CONSTRUCTION :warning:**

# MetPy Cookbook

[![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)
[![Binder](http://binder.projectpythia.org/badge_logo.svg)](http://binder.projectpythia.org/v2/gh/ProjectPythia/metpy-cookbook/main?labpath=notebooks)
[![DOI](https://zenodo.org/badge/620944317.svg)](https://zenodo.org/badge/latestdoi/620944317)

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

### The MetPy Example Gallery


## Running the Notebooks

You can either run the notebook using [Binder](https://mybinder.org/) or on your local machine.
Expand Down
15 changes: 1 addition & 14 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,6 @@ logo: pythia.png
email: [email protected]
copyright: "2024"

description: A sample cookbook description.
thumbnail: metpy.png
tags:
domains:
- meteorology
- data access
packages:
- metpy
- siphon
- cartopy
- xarray
- pint

execute:
# To execute notebooks via a binder instead, replace 'cache' with 'binder'
execute_notebooks: cache
Expand Down Expand Up @@ -50,7 +37,7 @@ sphinx:
html_permalinks_icon: '<i class="fas fa-link"></i>'
html_theme_options:
home_page_in_toc: true
repository_url: https://github.com/ProjectPythia/cookbook-template/ # Online location of your book
repository_url: https://github.com/ProjectPythia/metpy-cookbook/ # Online location of your book
repository_branch: main # Which branch of the repository should be used when creating links (optional)
use_issues_button: true
use_repository_button: true
Expand Down
11 changes: 11 additions & 0 deletions _gallery_info.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
thumbnail: metpy.png
tags:
domains:
- meteorology
- data access
packages:
- metpy
- siphon
- cartopy
- xarray
- pint
9 changes: 6 additions & 3 deletions _toc.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
format: jb-book
root: README
parts:
- caption: Preamble
chapters:
- file: notebooks/how-to-cite
- caption: The MetPy Gallery
chapters:
- file: notebooks/notebook-template
title: What organization
title: What organization
sections:
- glob: notebooks/gallery/*
- glob: notebooks/gallery/*
- file: notebooks/gallery/index1
title: do we want
- file: notebooks/gallery/index2
Expand All @@ -20,4 +23,4 @@ parts:
- file: notebooks/Skew-T_Analysis
- file: notebooks/Sounding_LCL_Dataset
- file: notebooks/Sounding_Plotter
- file: notebooks/Sounding_Calculations
- file: notebooks/Sounding_Calculations
7 changes: 7 additions & 0 deletions notebooks/how-to-cite
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 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.

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:

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