Skip to content

Commit

Permalink
fix content
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinSchobben committed Aug 2, 2024
1 parent bf60b7f commit f6b3a38
Show file tree
Hide file tree
Showing 7 changed files with 156 additions and 66 deletions.
49 changes: 9 additions & 40 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,15 @@ 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
- family-names: Schobben
given-names: Martin
orcid: https://orcid.org/0000-0001-8560-0037 # optional
website: https://github.com/martinschobben # optional
affiliation: Technische Universität Wien, Vienna, Austria # optional
- family-names: Pikall
given-names: Nikolas
website: https://github.com/npikall
affiliation: Technische Universität Wien, Vienna, Austria
- name: "Cookbook Template contributors" # use the 'name' field to acknowledge organizations
website: "https://github.com/ProjectPythia/cookbook-template/graphs/contributors"
title: "Cookbook Template"
Expand Down
38 changes: 17 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,43 @@
<img src="thumbnail.png" alt="thumbnail" width="300"/>
<img src="tuw-geo-logo.png" alt="tuw-geo-logo" width="300"/>

# (Replace_with_your_title) Cookbook
# Earth Observation Datascience Cookbook

[![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_)
This Project Pythia Cookbook covers a range of earth observation example employing the Pangeo philosophy.

## 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?)
The motivation behind this book is to provide some examples of Pangeo-based workflows applied to realistic examples in earth observation.

## Authors

[First Author](@first-author), [Second Author](@second-author), etc. _Acknowledge primary content authors here_
[Martin Schobben](@martinschobben), [Nikolas Pikall](@npikall)

### Contributors

<a href="https://github.com/ProjectPythia/cookbook-template/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ProjectPythia/cookbook-template" />
<a href="https://github.com/TUW-GEO/eo-datascience-cookbook/graphs/contributors">
<img src="https://contrib.rocks/image?repo=TUW-GEO/eo-datascience-cookbook" />
</a>

## 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.)
This book comprises a set of real life examples.

### Section 1 ( Replace with the title of this section, e.g. "Foundations" )
### Classification

(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 ... ")
This section offers an overview of ...

## Running the Notebooks

You can either run the notebook using [Binder](https://binder.projectpythia.org/) or on your local machine.
You can either run the notebook using [Binder](https://binder.eo-datascience-cookbook.org/) or on your local machine.

### Running on Binder

The simplest way to interact with a Jupyter Notebook is through
[Binder](https://binder.projectpythia.org/), which enables the execution of a
[Binder](https://binder.eo-datascience-cookbook.org/), which enables the execution of a
[Jupyter Book](https://jupyterbook.org) 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
Expand All @@ -61,20 +57,20 @@ If you are interested in running this material locally on your computer, you wil

(Replace "cookbook-example" with the title of your cookbooks)

1. Clone the `https://github.com/ProjectPythia/cookbook-example` repository:
1. Clone the `https://github.com/TUW-GEO/eo-datascience-cookbook` repository:

```bash
git clone https://github.com/ProjectPythia/cookbook-example.git
git clone https://github.com/TUW-GEO/eo-datascience-cookbook
```

1. Move into the `cookbook-example` directory
1. Move into the `eo-datascience-cookbook` directory
```bash
cd cookbook-example
cd eo-datascience-cookbook
```
1. Create and activate your conda environment from the `environment.yml` file
```bash
conda env create -f environment.yml
conda activate cookbook-example
conda activate eo-datascience-cookbook
```
1. Move into the `notebooks` directory and start up Jupyterlab
```bash
Expand Down
5 changes: 1 addition & 4 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,7 @@ sphinx:
use_repository_button: true
use_edit_page_button: true
use_fullscreen_button: true
analytics:
google_analytics_id: G-T52X8HNYE8
github_url: https://github.com/ProjectPythia
twitter_url: https://twitter.com/project_pythia
github_url: https://github.com/TUW-GEO
icon_links:
- name: YouTube
url: https://www.youtube.com/channel/UCoZPBqJal5uKpO8ZiwzavCw
Expand Down
Binary file removed thumbnail.png
Binary file not shown.
1 change: 0 additions & 1 deletion thumbnail.svg

This file was deleted.

Binary file added tuw-geo-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit f6b3a38

Please sign in to comment.