Skip to content

Commit 1c52c8c

Browse files
Ciheim BrownCiheim Brown
authored andcommitted
Updating READMe
1 parent 879099a commit 1c52c8c

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,28 @@
11
# CatalogBuilder
22

3+
The GFDL Catalog Builder is a python community package ecosystem” that allows users to generate data catalogs compatible with intake-esm.
4+
5+
Data catalogs simplify data discovery by creating customizable, extendable, and queryable catalogs.
6+
7+
If you would like to use the catalog builder, you must install the [conda package](https://anaconda.org/NOAA-GFDL/catalogbuilder), clone the [github repository](https://github.com/NOAA-GFDL/CatalogBuilder), or use the [FRE command line interface](https://github.com/NOAA-GFDL/fre-cli).
8+
9+
10+
Building a catalog would then look something like this:
11+
12+
```
13+
gen_intake_gfdl.py /archive/am5/am5/am5f3b1r0/c96L65_am5f3b1r0_pdclim1850F/gfdl.ncrc5-deploy-prod-openmp/pp $HOME/catalog
14+
```
15+
16+
OR
17+
18+
```
19+
fre catalog build --overwrite /archive/path_to_data_dir
20+
```
21+
22+
If you run into any problems please create an [issue](https://github.com/NOAA-GFDL/CatalogBuilder/issues) here.
23+
324
Cite our work: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5196586.svg)](https://doi.org/10.5281/zenodo.10787602)
425

5-
See our [project documentation site ](https://noaa-gfdl.github.io/CatalogBuilder/).
26+
For detailed information regarding the Catalog Builder see our [project documentation site ](https://noaa-gfdl.github.io/CatalogBuilder/).
627

728
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)