A Python Package for Stellar Photometry

Powered by Astropy Badge GitHub Workflow badge pre-commit.ci status codecov DOI

Stellarphot is a Python package to allow you to turn reduced astronomical images of point sources (e.g. stars) into useful photometry, with a focus on variable star and exoplanet transit observations. Specifically:

  • If you have reduced astronomical images as FITS files but haven't obtained photometry yet, stellarphot can perform aperture photometry on your images.
  • If you already have aperture photometry for a field, stellarphot can
    • choose comparison stars based on a catalog (e.g. APASS DR9),
    • calculate relative flux (like AstroImageJ),
    • calculate calibrated magnitudes by transforming to a catalog (e.g. APASS DR9), and/or
    • calculate calibrated magnitudes with a user-provided set of comparison stars (as is done in AAVSO submissions).
    • export ensemble photometry results in the AAVSO Extended File Format for direct upload to WebObs.
  • If you are working with exoplanet transit observations, stellarphot can turns the photometry into exoplanet transit light curves (see installation notes below).

Installation

stellarphot requires Python 3.10 or later.

You can install stellarphot with either pip or conda. If you are interested in stellarphot for exoplanet transit light curves, conda is recommended at the moment because of an issue with installing one of the dependencies.

  • Install with conda using

    conda install -c conda-forge stellarphot

    If you are interested in exoplanet light curve fitting, also install pytransit using

    conda install -c conda-forge pytransit

  • Install with pip. Most people want the full interactive experience (the Jupyter notebooks and widgets plus exoplanet fitting):

    pip install stellarphot[all]

    The optional dependencies are grouped into extras so you can install only what you need:

    • pip install stellarphot — base install. The headless/scriptable science engine (data structures, photometry, catalog access). Does not include the Jupyter/widget GUI.
    • pip install stellarphot[gui] — adds the notebook/widget interface.
    • pip install stellarphot[exoplanet] — adds exoplanet transit light-curve fitting (pytransit).
    • pip install stellarphot[all] — everything above.

Getting started with stellarphot

  1. Start Jupyterlab from the command line: jupyter lab
  2. Once JupyterLab opens in your web browser, open the Launcher (see Figure below)
  3. Click on the notebook you want (see figure below) and follow the instructions in the notebook. Output files and the settings used to generate them will show up in the file browser
stellarphot-screenshot

Questions?

Feel free to contact @mwcraig or @JuanCab with your questions about using stellarphot.

Contributors

Matt Craig
Matt Craig
🐛 💻 🎨 🤔 🚧 🧑‍🏫 🔬 👀 ⚠️ ✅		 Juan Cabanela
Juan Cabanela
🐛 💻 🎨 🤔 🚧 👀 📖		 madelyn914
madelyn914
🤔 📓		 Abby
Abby
📓		 MDeRung2021
MDeRung2021
🐛 📓		 Tanner Weyer
Tanner Weyer
💻 👀 📓		 Emily Watson
Emily Watson
🐛 📓
Adam Kline
Adam Kline
💻 📓		 Elias Holte
Elias Holte
💻		 P. L. Lim
P. L. Lim
🚧		 clkotnik
clkotnik
🤔		 Paige Meyer
Paige Meyer
📖		 stottsco
stottsco
💻		 Isobel Snellenberger
Isobel Snellenberger
💻 📓
Stefan Nelson
Stefan Nelson
💻 📓		 Nathan Walker
Nathan Walker
💻 📓		 Jane Glanzer
Jane Glanzer
💻 📓
Add your contributions

License

This project is Copyright (c) 2019-2024 The Stellarphot Team and licensed under the terms of the BSD 3-Clause license. This package is based upon the Astropy package template which is licensed under the BSD 3-clause license.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.1.2)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for mwcraig from gravatar.com mwcraig

Credits

Author: Matt Craig

License

BSD-3-Clause

Requires

Python >=3.11

Provides Extra

all docs exo-fitting exoplanet gui test

Report project as malware

Download files

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

Source Distribution

stellarphot-2.1.0.tar.gz (855.2 kB view details)

Uploaded Source

Built Distribution

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

stellarphot-2.1.0-py3-none-any.whl (947.6 kB view details)

Uploaded Python 3

File details

Details for the file stellarphot-2.1.0.tar.gz.

File metadata

  • Download URL: stellarphot-2.1.0.tar.gz
  • Upload date:
  • Size: 855.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for stellarphot-2.1.0.tar.gz
Algorithm Hash digest
SHA256 62ffae69fc5bf502d8bc61f35d3cd65607af96d6ecd2c613e34b67a55674cf1d
MD5 949684df8ec0cb3de4738df409bfc7d7
BLAKE2b-256 62e0154ff7b09508efc46116946a067306749b520aad9044f790b9b1817bc8f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for stellarphot-2.1.0.tar.gz:

Publisher: publish.yml on feder-observatory/stellarphot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file stellarphot-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: stellarphot-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 947.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for stellarphot-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e365ee3c234d2bb0d01632e3a8b94072e65d1a573a2b0865e7bf618040ed9e50
MD5 e8e55f907093f78df9d5bc05b490fb53
BLAKE2b-256 4f460e27fd0791701baf96ef0c119d61ed660f8fa251a8d9106fdf8a632d6a51

See more details on using hashes here.

Provenance

The following attestation bundles were made for stellarphot-2.1.0-py3-none-any.whl:

Publisher: publish.yml on feder-observatory/stellarphot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Pre-release

2.2.0b1

2 files

2.1.2

2 files

2.1.1

2 files

This release

2.1.0 This release

2 files

2.0.4

2 files

2.0.3

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

Pre-release

2.0.0b1

2 files

Pre-release

2.0.0a16

2 files

Pre-release

2.0.0a15

2 files

Pre-release

2.0.0a14

2 files

Pre-release

2.0.0a13

2 files

Pre-release

2.0.0a12

2 files

Pre-release

2.0.0a11

2 files

Pre-release

2.0.0a10

2 files

Pre-release

2.0.0a9

2 files

Pre-release

2.0.0a8

2 files

Pre-release

2.0.0a7

2 files

Pre-release

2.0.0a6

2 files

Pre-release

2.0.0a5

2 files

Pre-release

2.0.0a4

2 files

Pre-release

2.0.0a3

2 files

Pre-release

2.0.0a2

2 files

Pre-release

2.0.0a1

2 files

Yanked

2.0.0a0

2 files

Yanked reason: Wheels did not include JupyterLab launcher entries

1.4.15

2 files

1.4.14

2 files

1.4.13

2 files

1.4.12

2 files

1.4.11

2 files

1.4.10

2 files

1.4.9

2 files

1.4.8

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

1.4.4

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.9

2 files

1.3.8

2 files

1.3.7

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.1

2 files

1.2.0

2 files

1.1.9

2 files

1.1.8

2 files

1.1.7

2 files

1.1.6

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Supported by

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