Add references to now-external package features

jmert · Oct 23, 2022 · 9b057a6 · 9b057a6
1 parent 5c2c758
commit 9b057a6
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -25,6 +25,7 @@ makedocs(
     pages = [
         "CMB.jl Documentation" => "index.md",
         "Manual" => [
+            "Re-exported Packages" => "man/external.md",
             "Spherical Functions" => "man/sphere.md",
             "Observing Matrices" => "man/obsmat.md",
             "Pixel-pixel Covariance" => "man/pixelcov.md",

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -16,6 +16,7 @@ Design goals of this package include:
 ## User Manual and Documentation
 ```@contents
 Pages = [
+    "man/external.md",
     "man/sphere.md",
     "man/obsmat.md",
     "man/pixelcov.md",

diff --git a/docs/src/man/external.md b/docs/src/man/external.md
@@ -0,0 +1,32 @@
+# Re-exported Packages
+
+Some features are simply re-exported functions from other, external packages.
+These packages have (typically) been extracted from this package since they can be used
+in a self-contained manner, independently of their application to CMB analysis.
+
+For more information, see the documentation provided by each of the following packages:
+
+## [AssociatedLegendrePolynomials.jl](https://github.com/jmert/AssociatedLegendrePolynomials.jl)
+
+The associated Legendre polynomials (ALPs)constructs part of the eigenfunction basis for
+functions on the sphere and plays a very important role in analysis of signals on the
+sphere.
+In addition, the ALPs are required for the computation of
+[pixel-pixel covariance matrices](@ref man_pixelcov) that this package uniquely provides.
+
+Note that this package re-exports the `AssociatedLegendrePolynomials` module under the
+name `Legendre` for both backwards compatibility with earlier versions of this package
+as well as for brevity.
+
+## [SphericalHarmonics.jl](https://github.com/jmert/SphericalHarmonicTransforms.jl)
+
+The spherical harmonic transforms are a key analytical techniques used in analysis of the
+CMB.
+They are built on top of the associated Legendre polynomials.
+
+## [Healpix.jl](https://github.com/jmert/Healpix.jl)
+
+The HEALPix pixelization is a very common mapping format used in CMB (and other fields of
+astronomy more generally).
+For instance, this package provides the necessary glue to perform spherical harmonic
+transforms on a (scalar, i.e. temperature field) map in the HEALPix format.