Skip to content

Adding Intro files#2

Merged
khider merged 6 commits into
mainfrom
intro-md
May 7, 2026
Merged

Adding Intro files#2
khider merged 6 commits into
mainfrom
intro-md

Conversation

@doswal
Copy link
Copy Markdown
Collaborator

@doswal doswal commented Apr 21, 2026

Markdown documentation about :

  • NOAA and Pangaea Data Publishers.
  • Design philosophy of PyeloTUPS

Comment thread notebooks/01_a_DataProvider.md Outdated

### Data Provider:

In PyleoTUPS, a "Data Provider" is a backend paleoclimate repository that:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure many scientists will know "backend" in this context.

PANGAEA organizes datasets differently than NOAA:

```
Dataset (standalone publication)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of the NOAA diagram, it might make more sense to explain NOAA as you did PANGAEA here.

Unlike NOAA, one Pangaea Dataset contains only one Data Table i.e. 1 csv/tsv type file.
```
### PANGAEA Query Interface

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you want to explain what a faceted search is for paleoclimate scientists

---

## Next Steps

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

next step: can you link? Also this is part of the tutorials, so maybe we will need to refer to section 2 later on but would be a good idea to say next section for now. Instead of API reference, just say documentation with a link to readthedocs for complete parameter explanation

Copy link
Copy Markdown
Member

@khider khider left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Pull the noaa_ER_diagram in a figure folder (it won't be the only one and it will make the repo a bit cleaner) - if still needed. I like the style used for PANGAEA
  2. Look at the comments.

@doswal doswal requested a review from khider May 5, 2026 15:51
@khider khider merged commit ea27ff0 into main May 7, 2026
@khider khider deleted the intro-md branch May 7, 2026 23:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants