From 9eabd389577e5cfb247cd2a6a956f7c1eb6ce11d Mon Sep 17 00:00:00 2001
From: Ismael Mendoza <11745764+ismael-mendoza@users.noreply.github.com>
Date: Sun, 14 Nov 2021 15:40:59 -0500
Subject: [PATCH] Ensure PSF is consistently propagated if customized (#246)

* should be a public method

* remove mention of more examples that are non existant
---
 btk/main.py                         | 4 ++--
 btk/survey.py                       | 4 ++--
 notebooks/02b-custom-tutorial.ipynb | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/btk/main.py b/btk/main.py
index 337453196..da841442d 100644
--- a/btk/main.py
+++ b/btk/main.py
@@ -7,12 +7,12 @@
 from btk.measure import available_measure_functions
 from btk.measure import MeasureGenerator
 from btk.metrics import MetricsGenerator
-from btk.survey import _get_survey_from_cfg
+from btk.survey import get_survey_from_cfg
 
 
 def main(cfg: OmegaConf):
     """Run BTK from end-to-end using a hydra configuration object."""
-    surveys = [_get_survey_from_cfg(cfg.surveys[survey_name]) for survey_name in cfg.surveys]
+    surveys = [get_survey_from_cfg(cfg.surveys[survey_name]) for survey_name in cfg.surveys]
 
     # get draw blends generator.
     draw_blend_generator = instantiate(cfg.draw_blends, surveys=surveys)
diff --git a/btk/survey.py b/btk/survey.py
index 2682ce941..a6e4e07ca 100644
--- a/btk/survey.py
+++ b/btk/survey.py
@@ -63,7 +63,7 @@
     extinction (float): Exponential extinction coefficient for atmospheric absorption"""
 
 
-def _get_survey_from_cfg(survey_conf: OmegaConf):
+def get_survey_from_cfg(survey_conf: OmegaConf):
     """Creates the corresponding `btk.survey.Survey` object using the information from config file.
 
     Args:
@@ -129,7 +129,7 @@ def get_surveys(names="Rubin", overrides: Iterable = ()):
         cfg = compose("config", overrides=overrides)
     for survey_name in cfg.surveys:
         survey_conf = cfg.surveys[survey_name]
-        surveys.append(_get_survey_from_cfg(survey_conf))
+        surveys.append(get_survey_from_cfg(survey_conf))
     if len(surveys) == 1:
         return surveys[0]
     return surveys
diff --git a/notebooks/02b-custom-tutorial.ipynb b/notebooks/02b-custom-tutorial.ipynb
index 0b06fe8cf..3d72c6c38 100644
--- a/notebooks/02b-custom-tutorial.ipynb
+++ b/notebooks/02b-custom-tutorial.ipynb
@@ -337,7 +337,7 @@
     "- psf: PSF for the filter. This can be provided in two ways:\n",
     "    - Providing a Galsim PSF model, e.g. `galsim.Kolmogorov(fwhm)` or any convolution of such models.\n",
     "    - Providing a function which returns a Galsim model when called (with no arguments). This can be used when you \n",
-    "      you want to randomize the PSF. More on that in the example below.\n",
+    "      you want to randomize the PSF.\n",
     "    In the case of the default surveys, we only use the first possibility, computing the model using the get_psf function beforehand; those models have an atmospheric and an optical component.\n",
     "\n",
     "Surveys are usually imported using `btk.survey.get_surveys(survey_names)`, which will create the Survey object(s) from a config file (currently, the implemented surveys are Rubin, HSC, HST, Euclid, DES and CFHT); it is also possible to create them directly in Python.\n",