Skip to content

Commit c4917dc

Browse files
committed
Updated docs and changelog.
1 parent 44e495f commit c4917dc

File tree

4 files changed

+74
-5
lines changed

4 files changed

+74
-5
lines changed

CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,23 @@ All notable changes to ExoIris will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.0.0] - 2026-01-28
9+
10+
### Added
11+
- Added support for setting custom interpolation models for limb darkening via `set_limb_darkening_interpolator` method.
12+
- Added support for setting custom interpolation models for radius ratios via `set_radius_ratio_interpolator` method.
13+
- Added ability to set priors for offset parameters in the analysis workflow.
14+
- Added interpolation type tracking in FITS header metadata (`INTERP_LD` for limb darkening interpolation).
15+
16+
### Changed
17+
- Improved reinitialization logic for MCMC and differential evolution populations with updated limb darkening coefficients and knots.
18+
- Refactored interpolation handling in `TSLPF` to separately manage radius ratio and limb darkening interpolators.
19+
- Updated documentation for API methods and workflow.
20+
21+
### Fixed
22+
- Fixed incorrect FWHM scaling in `spot_model` function. The scaling factor now correctly uses `log(4)^(1/shape)` for
23+
proper full width at half maximum calculations in generalized Gaussian spot models.
24+
825
## [0.23.1] - 2025-12-18
926

1027
### Fixed

doc/source/api/exoiris.rst

Lines changed: 54 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,25 @@ transmission spectrum, and even the observational data can be changed to improve
6464
ExoIris.set_data
6565
ExoIris.set_radius_ratio_knots
6666
ExoIris.add_radius_ratio_knots
67+
ExoIris.set_limb_darkening_knots
68+
ExoIris.free_radius_ratio_knot_locations
6769
ExoIris.create_dense_radius_ratio_block
6870
ExoIris.plot_setup
6971

72+
Interpolation configuration
73+
---------------------------
74+
75+
ExoIris uses interpolation to model the wavelength-dependent radius ratio and limb darkening
76+
parameters. The interpolation method can be customized to balance smoothness against fidelity to the
77+
data. Available interpolators include: ``nearest``, ``linear``, ``pchip``, ``makima``, ``bspline``,
78+
``bspline-quadratic``, and ``bspline-cubic``.
79+
80+
.. autosummary::
81+
:toctree: api/
82+
83+
ExoIris.set_radius_ratio_interpolator
84+
ExoIris.set_limb_darkening_interpolator
85+
7086
Parameterization and priors
7187
---------------------------
7288

@@ -83,10 +99,11 @@ Noise model setup
8399
-----------------
84100

85101
The noise in the spectroscopic light curves can be modeled as either white noise or time-correlated noise
86-
(using a Gaussian process, GP). The noise model is chosen with the `ExoIris.noise_model` method, and can be
87-
set to either "white" or "fixed_gp." Selecting "fixed_gp" models the noise as a time-correlated Gaussian process
88-
using the `celerite2` package. The corresponding `celerite2.GaussianProcess` object can be accessed directly
89-
via the `ExoIris.gp` attribute.
102+
(using a Gaussian process, GP). The noise model is chosen with the `ExoIris.set_noise_model` method, and can be
103+
set to ``"white"``, ``"fixed_gp"``, or ``"free_gp"``. Selecting ``"fixed_gp"`` models the noise as a time-correlated
104+
Gaussian process using the `celerite2` package with fixed hyperparameters, while ``"free_gp"`` allows the GP
105+
hyperparameters to be sampled as free parameters. The corresponding `celerite2.GaussianProcess` object can be
106+
accessed directly via the `ExoIris.gp` attribute.
90107

91108
.. autosummary::
92109
:toctree: api/
@@ -98,6 +115,23 @@ via the `ExoIris.gp` attribute.
98115
ExoIris.gp
99116
ExoIris.plot_white_gp_predictions
100117

118+
Star spot modeling
119+
------------------
120+
121+
ExoIris supports modeling of star spot crossings during transit and the Transit Light Source Effect (TLSE).
122+
Star spots can cause both localized bumps in the light curve (when the planet occults a spot) and
123+
wavelength-dependent baseline variations (TLSE) due to the inhomogeneous stellar surface.
124+
125+
To use spot modeling, first initialize the spot model with `ExoIris.initialize_spots`, then add spots
126+
for specific epoch groups using `ExoIris.add_spot`.
127+
128+
.. autosummary::
129+
:toctree: api/
130+
131+
ExoIris.initialize_spots
132+
ExoIris.add_spot
133+
ExoIris.nspots
134+
101135

102136
First steps
103137
-----------
@@ -155,12 +189,27 @@ Pandas `~pandas.DataFrame`.
155189
:toctree: api/
156190

157191
ExoIris.transmission_spectrum
192+
ExoIris.transmission_spectrum_table
158193
ExoIris.posterior_samples
159194
ExoIris.plot_fit
160195
ExoIris.plot_transmission_spectrum
161196
ExoIris.plot_residuals
162197
ExoIris.plot_limb_darkening_parameters
163198

199+
Atmospheric retrieval
200+
---------------------
201+
202+
ExoIris provides tools for atmospheric retrieval by creating a log-likelihood function that can be
203+
used with external retrieval codes. The `ExoIris.create_loglikelihood_function` method returns a
204+
callable that evaluates the log-likelihood for a given transmission spectrum model, accounting for
205+
the full covariance structure of the data.
206+
207+
.. autosummary::
208+
:toctree: api/
209+
210+
ExoIris.create_loglikelihood_function
211+
ExoIris.transmission_spectrum_samples
212+
164213
Utility methods
165214
---------------
166215

@@ -186,6 +235,7 @@ The following properties expose key internal states and parameters of the analys
186235
ExoIris.nk
187236
ExoIris.nldp
188237
ExoIris.npb
238+
ExoIris.nspots
189239
ExoIris.ldmodel
190240
ExoIris.sampler
191241
ExoIris.optimizer

doc/source/api/tsdata.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Data wrangling
2828
TSData.bin_time
2929
TSData.crop_wavelength
3030
TSData.crop_time
31-
TSData.remove_outliers
31+
TSData.mask_outliers
3232
TSData.normalize_to_median
3333
TSData.normalize_to_poly
3434
TSData.partition_time

doc/source/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ Documentation
5252
api/exoiris
5353
api/tsdata
5454
api/binning
55+
api/ldtkld
56+
api/utilities
5557

5658
Support
5759
-------

0 commit comments

Comments
 (0)