Skip to main content

Repository Map

This documentation site describes three research codebases. Each lives in its own repository; this page says what is in each one and where its documentation is. The code repositories are the source of truth for the code, and the documentation never modifies them.

RepositoryTopicMain contentDocumentation
PhD-Brown/AstroSpectroStellar spectroscopy, machine learningsrc/ (pipeline/, dimred/, tools/, utils.py), notebooks/ (master pipeline, download, tools, validation, SHAP; dimred/ for the PHY-3500 notebooks), scripts/, data/, app.py, ROADMAP.mdAstroSpectro
PhD-Brown/AstroVisionGalaxy morphology, deep learningsrc/astrovision/ (data loading, models, fusion, uncertainty, Grad-CAM, morphometry, segmentation), notebooks/ 00–10, requirements.txtAstroVision
PhD-Brown/xi-dark-energy-bao-mcmcBayesian cosmological inferencesrc/ (xi_cosmo/, protocol 1 and 1b run scripts), notebooks/, results/, figures/, reports/, data/, docs/, tests/, Makefile, environment.yml, CITATION.cffξ Dark Energy
PhD-Brown/research-docsThis documentation sitewebsite/ (Docusaurus 3, three documentation instances), _facts/ (exported facts per project), scripts/, FACTS_INDEX.mdYou are here
PhD-Brown/PhD-Brown.github.ioPersonal academic websiteNot documented here—

How the repositories relate​

  • Facts flow one way. A script in research-docs exports result files from a code repository into _facts/<project>/; other scripts turn them into the data files read by the documentation components. No published figure is typed by hand. The procedure is described in the project FACTS_INDEX.md files.
  • AstroVision is the companion of AstroSpectro. The bridge between the two projects is described on Bridge to AstroSpectro.
  • The code repositories are read-only for the documentation. Corrections to a code or a result are made in the code repository, then exported again.

Where to look next​