Skip to main content

A thorough structure for precise photometry and forward modelling of time series of wide field images.

Project description

logo

JOSS tests Docs python pypi License: GPL v3

lightcurver

Welcome to lightcurver! This is a photometry library leveraging STARRED, best used with time series of wide-field images. You can read more about it in the documentation.

Essentially, lightcurver provides the infrastructure to

  • prepare a Point Spread Function (PSF) model for each wide-field image,
  • precisely calibrate the relative zero point between each image.

This enables STARRED to model the pixels of the region of interest (ROI), yielding of course high quality light curves of the point sources in the ROI, but also recovering the subpixel information to provide a high signal-to-noise ratio/resolution of the ROI itself. The example below shows a cutout of a wide-field image (one in a set of a hundred), the fitted high resolution model, and the Hubble Space Telescope image of the same region.

example_deconvolution

Features

  • Plate solving: uses Astrometry.net to establish the footprint of each frame.
  • Gaia reference stars: leverages Gaia information to select the right reference stars in the field of view of each frame.
  • Preserves sub-pixel information: never interpolates, essential to preserve the sub-pixel information that can be recovered by STARRED in a multi-epoch forward modelling.
  • Incremental: uses SQL queries to dynamically determine which process needs be executed on which frame.
  • Semi-automatic: create a yaml configuration file once for the first few frames, then run the pipeline whenever a new frame is added, providing auto-updating light curves.

Getting Started

  1. Installation: the short version, install via pip:

    pip install lightcurver
    

    The slightly longer version, in case you plan on using a GPU or the plate solving.

  2. Usage: Adapt the yaml config file template, then run the pipeline with

    lc_run /path/to/config.yaml
    

    The pipeline is incremental, but in a scenario of testing, you can run specific steps only, for example:

    lc_run /path/to/config.yaml --start stamp_extraction --stop psf_modeling
    

    (The names of the pipeline steps/tasks are listed upon running lc_run -h.)

  3. Tutorial: follow the tutorial of the documentation, which provides a dataset you can experiment with. You can also test your installation with a subset of the dataset provided in the tutorial:

    cd /clone/of/lightcurver
    pytest .
    

Contributing

If you're encountering problems, then I would like to hear about them and will try to fix them. Feel free to create an issue in this repository. If you're finding this package useful and want to contribute, please create a pull request after forking the repository. If you need general help, feel free to reach out!

License

lightcurver is licensed under the GPL v3.0 License. See the LICENSE file for more details.

The implemented processing steps

This is an overview of the steps taken by the pipeline. flowdiagram

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lightcurver-1.2.3.tar.gz (103.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lightcurver-1.2.3-py3-none-any.whl (123.1 kB view details)

Uploaded Python 3

File details

Details for the file lightcurver-1.2.3.tar.gz.

File metadata

  • Download URL: lightcurver-1.2.3.tar.gz
  • Upload date:
  • Size: 103.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for lightcurver-1.2.3.tar.gz
Algorithm Hash digest
SHA256 269a0a57cbfdd70196faee6a25f8edbf9f29868826e6b7bf94c427244be7e10c
MD5 fae5022ee2435d55edb926628f66a63b
BLAKE2b-256 54aba93e34e17fe417ed1413323be0da93b582242cfecd399058cdcdb62c5ca0

See more details on using hashes here.

File details

Details for the file lightcurver-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: lightcurver-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 123.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for lightcurver-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 dadccc8c83dc3c54f3240f8b5360c4595dd3a369a20acda56643e3c3aead5fec
MD5 48e18f8da6a8523e7648234b1c4645c3
BLAKE2b-256 b1339ddc29c932e58510c1c5b1c5a8790e657c0951d0d0877e23f1c2bbb96fd7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page