Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary
Last synced: 8 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: denisrosset
  • License: gpl-3.0
  • Language: Jupyter Notebook
  • Default Branch: master
  • Size: 4.39 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 5
  • Releases: 0
Created about 4 years ago · Last pushed about 4 years ago
Metadata Files
Readme Changelog License Citation

README.md

l1 periodogram

This repository contains a Python implementation of the l1 periodogram as described in Hara, Boué, Laskar, Correia 2017, MNRAS, Vol. 464, Issue 1, p.1220-1246, with a few more features. please cite this paper if you are using the code.

Description

The l1 periodogram is designed to search for periodicities in unevenly sampled time series. It can be used similarly as a Lomb-Scargle periodogram, and retrieves a figure which has a similar aspect but has fewer peaks due to aliasing. It is primarily designed for the search of exoplanets in radial velocity data, but can be also used for other purposes.

The principle of the algorithm is to search for a representation of the input signal as a sum of a small number of sinusoidal components, that is a representation which is sparse in the frequency domain. Here, "small number" means small compared to the number of observations.

The code is based on the Basis Pursuit minimization problem (Chen & Donoho 1998). In the present code, the Basis Pursuit problem can be solved with - The LARS algorithm (Efron, Hastie, Johnston, Tibshirani, R. 2004, Ann. Statist., Volume 32, Number 2, 407-499.) - The gglasso algorithm (Yang & Zou 2014. Statistics and Computing. 25(6), 1129-1141.) To use the latter, run the following command in the l1periodogram_codes folder.

Installation

Go to the repository root folder, and run:

bash python setup.py install

Necessary inputs

The mandatory inputs are: - A time series - The epochs of observation of the time series - A covariance model for the noise.

The other parameters are set by default, the most critical ones are: - The maximum frequency of the frequency grid - The unpenalized vectors: linear predictors that are known to be in the data (like offsets, trends, activity models).

Getting started

Download the l1periodogram repository onto your local computer. The notebook l1_periodogram_tutorial_I.pynb will walk you through the different features of the code. The notebook l1_periodogram_tutorial_II.pynb gets deeper into the details of what the code does.

You will also find a notebook dedicated to reproducing the results of Hara, Bouchy, Stalport, Boisse et al. 2020, A&A, 636, L6, called l1_periodogram_HD158259_analysis.ipynb

Credits

Written by Nathan C. Hara, with contributions from Alessandro R. Mari

Python packaging by Denis Rosset.

Owner

  • Name: Denis Rosset
  • Login: denisrosset
  • Kind: user
  • Location: Genève, Suisse
  • Company: Université de Genève

Citation (CITATION.cff)

cff-version: 1.2.0
title: L1 Periodogram
message: 'If you use this software, please cite it as below.'
type: software
authors:
  - given-names: Nathan C.
    family-names: Hara
    email: nathan.hara@unige.ch
    affiliation: University of Geneva
  - given-names: Denis
    family-names: Rosset
    email: physics@denisrosset.com
    affiliation: University of Geneva
    orcid: 'https://orcid.org/0000-0003-0444-7558'
  - given-names: Alessandro R.
    family-names: Mari
identifiers:
  - type: url
    value: 'https://ascl.net/2112.024'
    description: ASCL Code Record
repository: 'https://github.com/nathanchara/l1periodogram'
abstract: >-
  The l1 periodogram searches for periodicities in
  unevenly sampled time series. It can be used
  similarly as a Lomb-Scargle periodogram, and
  retrieves a figure which has a similar aspect but
  has fewer peaks due to aliasing. It is primarily
  designed for the search of exoplanets in radial
  velocity data, but can be also used for other
  purposes. The principle of the algorithm is to
  search for a representation of the input signal as
  a sum of a small number of sinusoidal components,
  that is a representation which is sparse in the
  frequency domain. Here, "small number" means small
  compared to the number of observations.
license: GPL-3.0

GitHub Events

Total
Last Year

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 96
  • Total Committers: 3
  • Avg Commits per committer: 32.0
  • Development Distribution Score (DDS): 0.281
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
NathanHara 3****a 69
Denis Rosset p****s@d****m 15
Nathan C. Hara 3****a 12
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 5
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • denisrosset (5)
Pull Request Authors
Top Labels
Issue Labels
tocheck (4)
Pull Request Labels

Dependencies

docs/requirements.txt pypi
  • matplotlib *
  • myst-nb *
  • scipy *
  • sphinx-autodoc-typehints *
  • sphinx-book-theme ==0.1.7
  • sphinxcontrib-bibtex *
requirements.txt pypi
  • matplotlib *
  • mypy *
  • numpy *
  • pandas *
  • scipy *
setup.py pypi
  • matplotlib *
  • numpy *
  • pandas *
  • scipy *