Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
LucaMalavolta committed Nov 12, 2024
1 parent e366675 commit 455124c
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 3 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ For nostalgic people, `PyORBIT` 8 and 9 are available as branches of the main re

## Updates on version 10

- The **exponential-sine periodic (ESP)** kernel is a fast approximation of the quasi-periodic (QP) kernel, implemented in the **`S+LEAF`** software by [Delisle et al. 2020](https://ui.adsabs.harvard.edu/abs/2020A%26A...638A..95D/abstract) and [Delisle et al. 2022](https://ui.adsabs.harvard.edu/abs/2022A%26A...659A.182D/abstract). The kernel has been implemented and tested in `PyORBIT`, and it can be used as a faster replacement of `tinyGP`
- **Version 10.8:** Additional BIC/AIC/AICc information in output and in dictionaries when running `pyorbit_results`. Information criteria computed through the ln-posterior (in addition to the ln-likelihood) have been dropped, as definitely wrong. This version is fully compatible with version **10.7**, as the only changes are in the analysis of the results.

- The **exponential-sine periodic (ESP)** kernel is a fast approximation of the quasi-periodic (QP) kernel, implemented in the **`S+LEAF`** software by [Delisle et al. 2020](https://ui.adsabs.harvard.edu/abs/2020A%26A...638A..95D/abstract) and [Delisle et al. 2022](https://ui.adsabs.harvard.edu/abs/2022A%26A...659A.182D/abstract). The kernel has been implemented and tested in `PyORBIT`, and it can be used as a faster replacement of `tinyGP`.

- Textual output is now also saved as dictionaries in the corresponding *dictionaries* folder.

Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Current version of `PyORBIT` is [![PyPI version fury.io](https://badge.fury.io/p
:::


:::{versionadded} 10.8

**Additional BIC/AIC/AICc information** in output and in dictionaries when running `pyorbit_results`. Information criteria computed through the ln-posterior (in addition to the ln-likelihood) have been dropped, as definitely wrong. This version is fully compatible with version **10.7**, as the only changes are in the analysis of the results. There is also a small bugfix regarding datasets not in chronological order which was preventing analysis with `spleaf_esp` model from starting altogether.

:::{versionadded} 10.7

**S+LEAF exponential-sine periodic kernel now supported**
Expand Down
2 changes: 1 addition & 1 deletion pyorbit/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@
from .subroutines.input_parser import yaml_parser


__version__ = "10.7.3"
__version__ = "10.8.0"
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

setup(
name="pyorbit-package",
version='10.7.3',
version='10.8.0',
author="Luca Malavolta",
author_email = 'luca.malavolta@unipd.it',
url = 'https://github.com/LucaMalavolta/PyORBIT',
Expand Down

0 comments on commit 455124c

Please sign in to comment.