Skip to content

Commit 188b5df

Browse files
committed
Update README
1 parent a6394f8 commit 188b5df

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,21 @@ This repository contains datasets for use in [Parcels](https://github.com/OceanP
77
## Available datasets
88

99
See [parcels/tools/exampledata_utils.py](https://github.com/OceanParcels/parcels/blob/main/parcels/tools/exampledata_utils.py) for a list of available datasets.
10+
11+
12+
## Adding a new dataset
13+
14+
1. Choose a (filename safe) name for your dataset. This will be used as a key to refer to the dataset in the Parcels, and will also be the name of the folder.
15+
2. Assuming you have your folder with your data files. E.g.,
16+
17+
```
18+
MovingEddies_data
19+
├── moving_eddiesP.nc
20+
├── moving_eddiesU.nc
21+
└── moving_eddiesV.nc
22+
```
23+
just move this to the `data` directory.
24+
25+
3. Update [parcels/tools/exampledata_utils.py](https://github.com/OceanParcels/parcels/blob/main/parcels/tools/exampledata_utils.py) accordingly to include your new dataset.
26+
27+
All NetCDF files are tracked by Git LFS. If you want to expand the files included in Git LFS, see the [GitHub docs](https://docs.github.com/en/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage).

0 commit comments

Comments
 (0)