fake-cookbook
A place to experiment with cookbook workflows
Science Score: 64.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 1 committers (100.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.0%) to scientific vocabulary
Repository
A place to experiment with cookbook workflows
Basic Info
- Host: GitHub
- Owner: brian-rose
- License: apache-2.0
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://brian-rose.github.io/fake-cookbook/
- Size: 1.85 MB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
- Releases: 0
Metadata Files
README.md
A Fake Cookbook
This Project Pythia Cookbook covers ... (replace ... with the main subject of your cookbook ... e.g., working with radar data in Python)
Motivation
(Add a few sentences stating why this cookbook will be useful. What skills will you, "the chef", gain once you have reached the end of the cookbook?)
Authors
Contributors
Structure
(State one or more sections that will comprise the notebook. E.g., This cookbook is broken up into two main sections - "Foundations" and "Example Workflows." Then, describe each section below.)
Section 1 ( Replace with the title of this section, e.g. "Foundations" )
(Add content for this section, e.g., "The foundational content includes ... ")
Section 2 ( Replace with the title of this section, e.g. "Example workflows" )
(Add content for this section, e.g., "Example workflows include ... ")
Running the Notebooks
You can either run the notebook using Binder or on your local machine.
Running on Binder
The simplest way to interact with a Jupyter Notebook is through
Binder, which enables the execution of a
Jupyter Book in the cloud. The details of how this works are not
important for now. All you need to know is how to launch a Pythia
Cookbooks chapter via Binder. Simply navigate your mouse to
the top right corner of the book chapter you are viewing and click
on the rocket ship icon, (see figure below), and be sure to select
“launch Binder”. After a moment you should be presented with a
notebook that you can interact with. I.e. you’ll be able to execute
and even change the example programs. You’ll see that the code cells
have no output at first, until you execute them by pressing
{kbd}Shift+{kbd}Enter. Complete details on how to interact with
a live Jupyter notebook are described in Getting Started with
Jupyter.
Running on Your Own Machine
If you are interested in running this material locally on your computer, you will need to follow this workflow:
(Replace "cookbook-example" with the title of your cookbooks)
- Clone the
https://github.com/brian-rose/fake-cookbookrepository:
bash
git clone https://github.com/ProjectPythia/cookbook-example.git
- Move into the
cookbook-exampledirectorybash cd cookbook-example - Create and activate your conda environment from the
environment.ymlfilebash conda env create -f environment.yml conda activate cookbook-example - Move into the
notebooksdirectory and start up Jupyterlabbash cd notebooks/ jupyter lab
Owner
- Name: Brian Rose
- Login: brian-rose
- Kind: user
- Location: Albany, NY, USA
- Company: University at Albany
- Website: http://www.atmos.albany.edu/facstaff/brose/index.html
- Twitter: BrianEJRose
- Repositories: 107
- Profile: https://github.com/brian-rose
Climate scientist, professor, and practitioner of open-source science. I use mathematical and numerical models to study climatic processes at the global scale.
Citation (CITATION.cff)
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
- name: "A Fake Cookbook" # use the 'name' field to acknowledge organizations
website: "https://github.com/brian-rose/fake-cookbook/graphs/contributors"
title: "Cookbook Template"
abstract: "A sample cookbook description."
GitHub Events
Total
Last Year
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Brian Rose | b****e@a****u | 15 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: about 1 year ago
All Time
- Total issues: 0
- Total pull requests: 6
- Average time to close issues: N/A
- Average time to close pull requests: about 2 hours
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.83
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- brian-rose (4)
- dependabot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- FranzDiebold/github-env-vars-action v2 composite
- FranzDiebold/github-env-vars-action v2 composite
- peter-evans/create-or-update-comment v3 composite
- peter-evans/find-comment v2 composite
- actions/checkout v3 composite
- jacobtomlinson/gha-find-replace v3 composite
- stefanzweifel/git-auto-commit-action v4 composite
- jupyter-book
- jupyter_server
- jupyterlab
- pip