Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andersy005 committed Jun 9, 2021
1 parent cdb8fd4 commit 0bba2ef
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,16 @@ To add a new dataset file, please follow these steps:
- retrieve and return the local path

```python
In [4]: filepath = DATASETS.fetch('jan-17-co-asos.txt.xz')
In [4]: filepath = DATASETS.fetch('jan-17-co-asos.txt.xz')

In [5]: filepath
Out[5]: '/Users/abanihi/Library/Caches/pythia-datasets/jan-17-co-asos.txt.xz'
In [5]: filepath
Out[5]: '/Users/abanihi/Library/Caches/pythia-datasets/jan-17-co-asos.txt.xz'
```

- Once you have access to the local filepath, you can then use it to load your dataset into pandas or xarray or your package of choice:

```python
In [6]: df = pd.read_csv(filepath)
```

[github-ci-badge]: https://img.shields.io/github/workflow/status/ProjectPythia/pythia-datasets/CI?label=CI&logo=github&style=for-the-badge
Expand All @@ -71,7 +77,3 @@ To add a new dataset file, please follow these steps:
[conda-link]: https://anaconda.org/conda-forge/pythia-datasets
[license-badge]: https://img.shields.io/github/license/ProjectPythia/pythia-datasets?style=for-the-badge
[repo-link]: https://github.com/ProjectPythia/pythia-datasets

```
```

0 comments on commit 0bba2ef

Please sign in to comment.