From 2ee4310105e0e530137539314924e0055fb91802 Mon Sep 17 00:00:00 2001
From: tgalvin <tim.galvin@csiro.au>
Date: Wed, 31 Jul 2024 22:27:59 +0800
Subject: [PATCH] Catalogues class renamed / some notes

---
 flint/catalogue.py  |  9 ++++++++-
 flint/validation.py | 11 ++++++-----
 2 files changed, 14 insertions(+), 6 deletions(-)

diff --git a/flint/catalogue.py b/flint/catalogue.py
index 44ec2fbb..f6030956 100644
--- a/flint/catalogue.py
+++ b/flint/catalogue.py
@@ -1,4 +1,11 @@
-"""Utilities around catalogues"""
+"""Utilities around catalogues. 
+
+Known reference catalogues are described by their ViZeR catalogue id,
+which are used to download and store the appropriately formed catalogues on disk.
+If the ViZeR service is down then attempts to download and form FITS catalgoues
+will fail. These only need to be downloaded once, provided they can be stored
+and retained on disk.  
+"""
 
 from argparse import ArgumentParser
 from pathlib import Path
diff --git a/flint/validation.py b/flint/validation.py
index bc6009b5..fd0ab353 100644
--- a/flint/validation.py
+++ b/flint/validation.py
@@ -30,8 +30,9 @@
 F_HUGE = 20
 
 
-class Catalogues(NamedTuple):
-    """Container for all the catalogues that are loaded in"""
+class ValidationCatalogues(NamedTuple):
+    """Container for all the catalogues that are loaded in and
+    used throughout validation processing"""
 
     nvss: Catalogue
     """NVSS catalogue"""
@@ -1065,7 +1066,7 @@ def load_catalogues(
     reference_catalogue_directory: Path,
     askap_survey_name: str,
     rms_info: RMSImageInfo,
-) -> Tuple[Catalogues, Tables]:
+) -> Tuple[ValidationCatalogues, Tables]:
     """Load in all the catalogues that are required for the validation.
 
     Args:
@@ -1075,7 +1076,7 @@ def load_catalogues(
         rms_info (RMSImageInfo): The extracted information from the RMS image
 
     Returns:
-        Tuple[Catalogues, Tables]: The loaded catalogues and tables
+        Tuple[ValidationCatalogues, Tables]: The loaded catalogues and tables
     """
     logger.info(f"Loading {source_catalogue_path=}")
     askap_table = Table.read(source_catalogue_path)
@@ -1102,7 +1103,7 @@ def load_catalogues(
     )
 
     return (
-        Catalogues(
+        ValidationCatalogues(
             askap=askap_cata,
             icrf=icrf_catalogue,
             sumss=sumss_catalogue,