feat(emcee): implement get_expected_outputs (closes #804)

CHANGELOG.md

@@ -5,6 +5,9 @@ The original MRs are only visible on the [LIGO GitLab repository](https://git.li
 
 ## [Unreleased]
 
+### Fixes
+* Implemented `get_expected_outputs` for the `Emcee` sampler, which now correctly reports the `chain.dat` and `sampler.pickle` files it writes to the run directory (closes #804)
+
 ## [2.7.1]
 
 ### Fixes

bilby/core/sampler/emcee.py

@@ -439,3 +439,39 @@ def _generate_result(self):
         self.result.log_prior_evaluations = log_priors
         self.result.log_evidence = np.nan
         self.result.log_evidence_err = np.nan
+
+    @classmethod
+    def get_expected_outputs(cls, outdir=None, label=None):
+        """Get lists of the expected outputs directories and files.
+
+        These are used by :code:`bilby_pipe` when transferring files via HTCondor.
+        The emcee sampler writes its checkpoint information (the serialised
+        sampler and the tab-separated chain history) inside a per-run
+        subdirectory ``{outdir}/emcee_{label}/``. The files written there are:
+
+        - ``chain.dat``: tab-separated chain history, one row per step per
+          walker, updated incrementally as the sampler runs.
+        - ``sampler.pickle``: a dill-pickled copy of the
+          :class:`emcee.EnsembleSampler` instance, used to resume from the
+          last completed step.
+
+        Parameters
+        ----------
+        outdir : str
+            The output directory.
+        label : str
+            The label for the run.
+
+        Returns
+        -------
+        list
+            List of file names produced by the sampler.
+        list
+            List of directory names produced by the sampler.
+        """
+        run_dir = os.path.join(outdir, f"emcee_{label}")
+        filenames = [
+            os.path.join(run_dir, "chain.dat"),
+            os.path.join(run_dir, "sampler.pickle"),
+        ]
+        return filenames, [run_dir]

test/core/sampler/emcee_test.py

@@ -1,3 +1,4 @@
+import os
 import unittest
 
 import bilby
@@ -71,5 +72,19 @@ def test_translate_kwargs(self):
             self.assertDictEqual(expected, self.sampler.kwargs)
 
 
+def test_get_expected_outputs():
+    label = "par0"
+    outdir = os.path.join("some", "bilby_pipe", "dir")
+    filenames, directories = bilby.core.sampler.emcee.Emcee.get_expected_outputs(
+        outdir=outdir, label=label
+    )
+    assert len(filenames) == 2
+    assert len(directories) == 1
+    run_dir = os.path.join(outdir, f"emcee_{label}")
+    assert run_dir in directories
+    assert os.path.join(run_dir, "chain.dat") in filenames
+    assert os.path.join(run_dir, "sampler.pickle") in filenames
+
+
 if __name__ == "__main__":
     unittest.main()