Skip to content

Commit

Permalink
Minor updates to README, fixed list-temporal-after test
Browse files Browse the repository at this point in the history
  • Loading branch information
LiamBindle committed Feb 28, 2022
1 parent 9cfcb7c commit 0562ec4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ The bashdatacatalog was written to facilitate downloading input data for users o

_Note: Consider giving the bashdatacatalog a Star :star: if you find it useful. This increase visibility and helps justify maintaining this repository._

## 📋 Key Terminology
## 📋 Key Terms

Data is organized with _collections_ and _catalogs_.

_collection_ - A *data collection* is a data directory. A data collection may have any number of files, any types of files, and have subdirectories.
_collection_ - A *data collection* is a directory (folder) that has data files. A data collection may have any number of files, any types of files, and have subdirectories.

_catalog_ - A file that groups data colleciton together, and includes some details about the collections. A catalog file includes (1) the local paths to data collections, (2) the URLs of the data sources, and (3) boolean flags to enable/disable data collections.

Expand Down Expand Up @@ -43,9 +43,11 @@ _Note: This command upgrades the bashdatacatalog if it's already installed._
```
## 💡 Documentation

See the Wiki for instructions: https://github.com/LiamBindle/bashdatacatalog/wiki.
See the Wiki for documentation on using the bashdatacatalog: https://github.com/LiamBindle/bashdatacatalog/wiki.

Also, see
If you are a GEOS-Chem user, see the standalone instructions for GEOS-Chem users [here](https://github.com/LiamBindle/bashdatacatalog/wiki/Instructions-for-GEOS-Chem-Users).

For options and arguments to the `bashdatacatalog-list` command, see
```console
$ bashdatacatalog-list -h
```
4 changes: 2 additions & 2 deletions tests/01.basic/list-temporal-after
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ TEST_NAME="list temporal after"
TEST_DIRECTORY=$(dirname $(which bashdatacatalog-list))/../sandbox

TEST_COMMANDS=$(cat << END_OF_TEST
bashdatacatalog-list -t -r 2019 collection2
bashdatacatalog-list -t -r 2019, collection2
END_OF_TEST
)

Expand All @@ -12,4 +12,4 @@ TEST_EXPECTED_OUTPUT=$(cat << END_OF_EXPECTED_OUTPUT
./collection2/2019/file-20190403
./collection2/2019/file-20190803
END_OF_EXPECTED_OUTPUT
)
)

0 comments on commit 0562ec4

Please sign in to comment.