Skip to content

Commit cdb8fd4

Browse files
committed
Update docs
1 parent 0f763c9 commit cdb8fd4

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# pythia-datasets
2-
31
| CI | [![GitHub Workflow Status][github-ci-badge]][github-ci-link] [![GitHub Workflow Status][github-lint-badge]][github-lint-link] [![Code Coverage Status][codecov-badge]][codecov-link] |
42
| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
53
| **Docs** | [![Documentation Status][rtd-badge]][rtd-link] |
64
| **Package** | [![Conda][conda-badge]][conda-link] [![PyPI][pypi-badge]][pypi-link] |
75
| **License** | [![License][license-badge]][repo-link] |
86

7+
# pythia-datasets
8+
99
Data repository for Project Pythia examples/notebooks
1010

1111
## Sample data sets
@@ -16,15 +16,15 @@ These files are used as sample data in Pythia Project examples/notebooks and are
1616
- `enso_data.csv`
1717
- `jan-17-co-asos.txt.xz`
1818

19-
### Adding new datasets
19+
## Adding new datasets
2020

2121
To add a new dataset file, please follow these steps:
2222

2323
1. Add the dataset file to the `data/` directory
2424
2. From the command line, run `python make_registry.py` script to update the registry file residing in `pythia_datasets/registry.txt`
2525
3. Commit and push your changes to GitHub
2626

27-
### Using datasets in notebooks and/or scripts
27+
## Using datasets in notebooks and/or scripts
2828

2929
- Ensure the `pythia_datasets` package is installed in your environment
3030

@@ -57,8 +57,6 @@ To add a new dataset file, please follow these steps:
5757
Out[5]: '/Users/abanihi/Library/Caches/pythia-datasets/jan-17-co-asos.txt.xz'
5858
```
5959

60-
```
61-
6260
[github-ci-badge]: https://img.shields.io/github/workflow/status/ProjectPythia/pythia-datasets/CI?label=CI&logo=github&style=for-the-badge
6361
[github-lint-badge]: https://img.shields.io/github/workflow/status/ProjectPythia/pythia-datasets/linting?label=linting&logo=github&style=for-the-badge
6462
[github-ci-link]: https://github.com/ProjectPythia/pythia-datasets/actions?query=workflow%3ACI
@@ -73,4 +71,7 @@ To add a new dataset file, please follow these steps:
7371
[conda-link]: https://anaconda.org/conda-forge/pythia-datasets
7472
[license-badge]: https://img.shields.io/github/license/ProjectPythia/pythia-datasets?style=for-the-badge
7573
[repo-link]: https://github.com/ProjectPythia/pythia-datasets
74+
75+
```
76+
7677
```

0 commit comments

Comments
 (0)