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.11 or later. You can install stellarphot using uv, pixi, pip or conda. These tools access one of two package repositories, conda-forge or PyPI.

  • uv and pip use the PyPI package repository which currently has the following version of stellarphot: PyPI version
  • pixi and conda use the conda-forge package repository (although pixi can use PyPI instead) which currently has the following version of stellarphot: Conda-forge version

Both pixi and uv work on a model where you create a working directory for your project and install the packages into that working directory. This is a good way to keep your work organized and avoid conflicts with other Python packages you may have installed. You can examine the documentation for uv or pixi for details on how to use those tools.

conda and pip work on a model where you install the packages into your existing Python environment. This allows you to get started quickly, but you may run into conflicts with other packages you have installed.

Available extras

stellarphot's dependencies are grouped into options so you can install only what you need:

Option Adds
(none, base install) The headless/scriptable engine (data structures, photometry, catalog access). Does not include the Jupyter/widget GUI.
gui The Jupyter notebook/widget interface.
exoplanet Exoplanet transit light-curve fitting (pytransit).
all Everything above.

Note: Only the full (all) install is available from conda-forge, via conda or pixi's conda-forge mode (see the all row below for both pixi commands). Partial installs (gui or exoplanet alone) require PyPI, via pixi --pypi, uv, or pip.

Environmental Setup

uv and pixi first need a project directory to install into (replace project_dir_name with a name of your choice):

uv init project_dir_name && cd project_dir_name    # uv
pixi init project_dir_name && cd project_dir_name  # pixi

conda and pip install directly into your current Python environment, so no setup step is needed.

Installation commands

Option uv pixi conda pip
base uv add stellarphot pixi add --pypi stellarphot โ€” pip install stellarphot
gui uv add "stellarphot[gui]" pixi add --pypi "stellarphot[gui]" โ€” pip install "stellarphot[gui]"
exoplanet uv add "stellarphot[exoplanet]" pixi add --pypi "stellarphot[exoplanet]" โ€” pip install "stellarphot[exoplanet]"
all uv add "stellarphot[all]" pixi add stellarphot (conda-forge)
pixi add --pypi "stellarphot[all]" (PyPI)		 conda install -c conda-forge stellarphot pip install "stellarphot[all]"

Getting started with stellarphot

  1. Start Jupyterlab from the command line: jupyter lab (or uv run jupyter lab or pixi run jupyter lab if you installed with uv or pixi).
  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-2026 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

Data verified by PyPI on Jul 19, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

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

Credits

Author: The Stellarphot Team

GitHub Statistics

Data verified by PyPI on Jul 19, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

BSD-3-Clause
View SPDX License List

Requires

Python >=3.11

Provides Extra

all docs 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.2.tar.gz (856.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.2-py3-none-any.whl (948.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for stellarphot-2.1.2.tar.gz
Algorithm Hash digest
SHA256 a631209550ec5ac5b1ee1d02a3c2e397695c51e9d84977e809f4c6fe440f647b
MD5 eb0f9570fa214110d3b5e871b472846c
BLAKE2b-256 41a0e7ade113a816bedc753ac519ff87bde24c97148ae26a74be74c075e0955f

See more details on using hashes here.

Provenance

The following attestation bundles were made for stellarphot-2.1.2.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.2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for stellarphot-2.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 11f429ebeb552466592d2b329cf4f4171fbd2f37336015065f818d2d81a9bec6
MD5 93242fc9f429ef27ff7fd1af768205e2
BLAKE2b-256 eb8c0c59563d2a7986fb1b02fcc06e8caa0bde67e61c04cf0b245d2d0556089d

See more details on using hashes here.

Provenance

The following attestation bundles were made for stellarphot-2.1.2-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

This release

2.1.2 This release

2 files

2.1.1

2 files

2.1.0

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