v0.5.0

IntrinsicTimescales v0.5.0

Diff since v0.4.1

Breaking Changes:

• Plotting capabilities now live inside an extension. What this means is if the user intends to use acwplot and posterior_predictive functions, they would need to first using Plots.

New Features:

• Added skip_zero_lag option to acw function. When true, ignores the zero-lag in :tau setting and fits a 3-parameter exponential decay function of the form acf(lag) = A * (exp(-lag / tau) + B).
• Option for setting rng and seed for reproducibility in the Ornstein-Uhlenbeck process generation.

Example usage:

tau = 1.0
true_D = 1.0
dt = 0.01
duration = 10.0
num_trials = 100
deq_seed = 42

ou, _ = generate_ou_process_sciml(tau, true_D, dt, duration, num_trials, true, rng=Xoshiro(42), deq_seed=deq_seed)

• acwplot now indicates the estimated knee frequency with a vertical line. Should make it easier to see if acw is working properly for :knee option.

Minor changes

• Added the tutorial "Navigating the Forest of INT metrics"
• Added "Contribution Guidelines" and "Developer Documentation" to the documentation
• Updated all the docstrings to match the code.

Merged pull requests:

• 25 joss add rng for random function (#26) (@duodenum96)
• 22 acw docstring (#27) (@duodenum96)
• add skip_zero_lag option to acw (#28) (@duodenum96)
• 24 joss documentation (#29) (@duodenum96)

Closed issues:

• [joss] dependencies (#20)
• acw DocString (#22)