From 20348cdd89ec515b7e15bb234385ec3b537ff88c Mon Sep 17 00:00:00 2001 From: Peter Deiml Date: Thu, 17 May 2018 10:20:25 +0200 Subject: [PATCH 1/2] Renaming of configuration folder --- gammacat/catalog.py | 4 ++-- input/{gammacat => gamma_cat_config}/README.md | 0 input/{gammacat => gamma_cat_config}/gamma_cat_columns.yaml | 0 input/{gammacat => gamma_cat_config}/gamma_cat_dataset.yaml | 0 4 files changed, 2 insertions(+), 2 deletions(-) rename input/{gammacat => gamma_cat_config}/README.md (100%) rename input/{gammacat => gamma_cat_config}/gamma_cat_columns.yaml (100%) rename input/{gammacat => gamma_cat_config}/gamma_cat_dataset.yaml (100%) diff --git a/gammacat/catalog.py b/gammacat/catalog.py index ef910d6b..0b415660 100644 --- a/gammacat/catalog.py +++ b/gammacat/catalog.py @@ -69,7 +69,7 @@ def __init__(self, data, path): @classmethod def read(cls): - path = gammacat_info.base_dir / 'input/gammacat/gamma_cat_dataset.yaml' + path = gammacat_info.base_dir / 'input/gamma_cat_config/gamma_cat_dataset.yaml' data = load_yaml(path) return cls(data=data, path=path) @@ -513,7 +513,7 @@ class CatalogSchema: """Helper class to apply the schema.""" def __init__(self): - self.colspecs = load_yaml(gammacat_info.base_dir / 'input/gammacat/gamma_cat_columns.yaml') + self.colspecs = load_yaml(gammacat_info.base_dir / 'input/gamma_cat_config/gamma_cat_columns.yaml') def format_table(self, in_table): """Make a new table, formatting things according to this schema. diff --git a/input/gammacat/README.md b/input/gamma_cat_config/README.md similarity index 100% rename from input/gammacat/README.md rename to input/gamma_cat_config/README.md diff --git a/input/gammacat/gamma_cat_columns.yaml b/input/gamma_cat_config/gamma_cat_columns.yaml similarity index 100% rename from input/gammacat/gamma_cat_columns.yaml rename to input/gamma_cat_config/gamma_cat_columns.yaml diff --git a/input/gammacat/gamma_cat_dataset.yaml b/input/gamma_cat_config/gamma_cat_dataset.yaml similarity index 100% rename from input/gammacat/gamma_cat_dataset.yaml rename to input/gamma_cat_config/gamma_cat_dataset.yaml From 1efadae5c68148a824d22761f7022ddeb9671011 Mon Sep 17 00:00:00 2001 From: Peter Deiml Date: Thu, 17 May 2018 10:34:41 +0200 Subject: [PATCH 2/2] Improve documentation --- webpage/data/catalog.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/webpage/data/catalog.rst b/webpage/data/catalog.rst index 3c99fdab..bc3b553b 100644 --- a/webpage/data/catalog.rst +++ b/webpage/data/catalog.rst @@ -16,4 +16,7 @@ Why multiple formats? It supports vector columns, which we use for spectral points. * The ECSV and YAML variant are more for us working on gamma-cat, to have a text-based, version control friendly format where it's - easy to see which changes occurred from one version to the next. \ No newline at end of file + easy to see which changes occurred from one version to the next. + +We recommend to have a look at `gamma_cat_columns `__ in which all columns of the catalog are defined together with additional information, e.g. description and datatype of the entry. +Moreover, in `gamma_cat_dataset `__ for each source the reference_id of the data in the catalog is given (more precicely, this file tells the python scripts which references are used to create the catalog).