diff --git a/coolest/api/README.md b/coolest/api/README.md index e2c28e2..c7e1e8c 100644 --- a/coolest/api/README.md +++ b/coolest/api/README.md @@ -1,22 +1,13 @@ # COOLEST API: `coolest.api` submodule +## Analysis with `coolest.api.analysis` -## Analysis: `coolest.api.analysis` +Based on a `coolest` object, the `Analysis` class handles computation of model-independent quantities, including the Einstein radius, mass density slope, effective radius, axis ratio from central moments, etc. -- load the content of a COOLEST file -- perform computations of model-independent quantities: - - effective Einstein radius - - effective mass density slope - - effective (half-light) radius +## Models: `coolest.api.composable_model` +Based on a `coolest` object, a "composable model" selects the required light and mass model components, and performs lens model computations, including convolution by the PSF, ray-tracing and supersampling. ## Plotting: `coolest.api.plotting` -- instantiate an `Analysis` object from a COOLEST file -- defines general settings for all plots (colors, cmaps, etc...) -- could have child classes - - Obervationlotter(Plotter) - - LightPlotter(Plotter) - - LensLightPlotter(LightPlotter) - - SourcePlotter(LightPlotter) - - MassPlotter(Plotter) +The plotting routines, separated into different classes, allow the user to visualize the lens models, optionally evaluating the model components on different types of grid (`ModelPlotter`, `MultiModelPlotter`), or generate posterior distributions plots (`ParametersPlotter`). diff --git a/coolest/api/analysis.py b/coolest/api/analysis.py index a5f2502..39a2c9f 100644 --- a/coolest/api/analysis.py +++ b/coolest/api/analysis.py @@ -10,6 +10,10 @@ # logging settings logging.getLogger().setLevel(logging.INFO) +__all__ = [ + 'Analysis', +] + class Analysis(object): """Handles computation of model-independent quantities and other analysis computations. diff --git a/coolest/api/plotting.py b/coolest/api/plotting.py index 8119b75..fdc1560 100644 --- a/coolest/api/plotting.py +++ b/coolest/api/plotting.py @@ -26,6 +26,11 @@ # TODO: separate ParametersPlotter from ModelPlotter to avoid dependencies on getdist +__all__ = [ + 'ModelPlotter', + 'MultiModelPlotter', + 'ParametersPlotter', +] class ModelPlotter(object): """Create pyplot panels from a lens model stored in the COOLEST format. diff --git a/coolest/api/test_einstein_rad.ipynb b/coolest/api/tests/test_einstein_rad.ipynb similarity index 100% rename from coolest/api/test_einstein_rad.ipynb rename to coolest/api/tests/test_einstein_rad.ipynb