Skip to content

Commit fe761fc

Browse files
Guidance on scope of this repo (#82)
* Guidance on scope of this repo Addresses #20 by expressing the scope of the repo. New datasets should be added if needed specifically for Foundations. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent a025762 commit fe761fc

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66

77
# pythia-datasets
88

9-
Data repository for Project Pythia examples/notebooks
9+
Data repository for with sample data for the [Pythia Foundations](https://foundations.projectpythia.org) book.
1010

1111
## Sample data sets
1212

13-
These files are used as sample data in Pythia Project examples/notebooks and are downloaded by `pythia_datasets` package:
13+
These files are used as sample data in [Pythia Foundations](https://foundations.projectpythia.org) and are downloaded by `pythia_datasets` package:
1414

1515
- `NARR_19930313_0000.nc`
1616
- `enso_data.csv`
@@ -21,7 +21,8 @@ These files are used as sample data in Pythia Project examples/notebooks and are
2121

2222
## Adding new datasets
2323

24-
To add a new dataset file, please follow these steps:
24+
The scope of this data collection is to serve examples for [Pythia Foundations](https://foundations.projectpythia.org).
25+
If you are adding new content to Foundations that requires a new dataset file, please follow these steps:
2526

2627
1. Add the dataset file to the `data/` directory
2728
2. From the command line, run `python make_registry.py` script to update the registry file residing in `pythia_datasets/registry.txt`

0 commit comments

Comments
 (0)