Skip to main content
ReadTheDocs PyPI-Server Project generated with PyScaffold https://zenodo.org/badge/DOI/10.5281/zenodo.8216472.svg https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg Project Status: Active – The project has reached a stable, usable state and is being actively developed. Build Status Coverage Supported Python versions pyOpenSci Peer-Reviewed https://joss.theoj.org/papers/10.21105/joss.09534/status.svg

GALFITools

GALFIT, a well-established two-dimensional image fitting algorithm, as outlined in the work by Peng et al. (2002, AJ, 124, 266), serves as the basis for precise astronomical image surface brightness analysis. In pursuit of optimizing the utilization of GALFIT, GALFITools emerges as an collection of Python routines. These routines enhances the input and output parsing associated with GALFIT.

GALFITools extends its utility through an array of functionalities, including the facilitation of mask creation, star selection for PSFs, generation of multiple initial parameters, simulate galaxy images, multigaussian expansion (MGE) fitting, as well as computation of sky background and other pertinent photometric variables.

NOTE: GALFITools assumes the user has a basic knowledge of GALFIT and SaoImage DS9. How to use GALFIT is found in the official GALFIT webpage. The DS9 webpage can be found here and a basic tutorial here. Useful concepts with related functions and CLI commands can be found here.


Installation Instructions

First of all, install GALFIT if you haven’t done so. Check instructions here. Make sure that GALFIT can run in any path in your linux/macOS terminal.

If you want to learn how to use GALFIT, click here.

GALFITools supports Python 3.9 through 3.13. Optionally, we recommend using a virtual environment

Install GALFITools via pip:

pip install GALFITools

Here is a detailed video tutorial on installing GALFITools using a virtual environment created with Conda:

IMAGE ALT TEXT HERE

Get Started with GALFITools

Once installed, you can test GALFITools using any of the commands in the console.

In the example below, the command getReComp is executed in a terminal using the GALFIT output file galfit.01 to calculate the effective radius of a model with three Sersic components:

$ getReComp galfit.01
GALFITools: a library for GALFIT
Version: 1.14.1
webpage: https://github.com/canorve/GALFITools

number of model components:  3
Using a theta value of : 14.13 degrees

Total Magnitude of the galaxy: 9.79

Surface brightness at radius of 50% of light (μr): 21.15 mag/''

Mean Surface Brightness at effective radius (<μ>e): 20.27 mag/''

The radius at 50% of light is 199.64 pixels or 49.91 "

Documentation

Full documentation along usage guide can be found in https://galfitools.readthedocs.io/en/latest/.


Contributing and Support

Let us know if you have issues, questions or innovative suggestions arise, we encourage you to reach out via email to canorve [at] gmail [dot] com or initiate a discussion by opening an issue. Your input is invaluable in fostering the continual refinement of GALFITools, for the betterment of the GALFIT community and beyond.


License

The codebase of GALFITools is governed by the terms of the MIT license.


Credit / Citation

If you find this code useful in your research, please use the “Cite this repository” option in the GitHub sidebar.


Additonal Resources

For further capabilities and valuable extensions pertaining to GALFIT output, such as the generation of surface brightness profiles and estimation of other photometric parameters, we invite you to explore the EllipSect tool:

EllipSect


Note

This project has been set up using PyScaffold 4.2.1. For details and usage information on PyScaffold see https://pyscaffold.org/.

Metadata

Release files for GALFITools 1.36.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for GALFITools 1.36.0
File Size Uploaded
galfitools-1.36.0.tar.gz 26.0 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for GALFITools 1.36.0
File Interpreter ABI Platform
galfitools-1.36.0-py3-none-any.whl Python 3 none any Details

Total release size: 26.2 MB

Release files / galfitools-1.36.0.tar.gz

Download URL galfitools-1.36.0.tar.gz
Size 26.0 MB
Tags Source
SHA-256 checksum
How to use checksums
341b8bd3d94d22ae2d7bed9cdfafeaf7b32c7839112f0f613fb1826aad386a66
BLAKE2b-256 checksum
How to use checksums
a4b39ab9ac79f7fdccf265890800c68644209751454d87b87868cda64e113c21
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 26, 2026.

Transparency log

Release files / galfitools-1.36.0-py3-none-any.whl

Download URL galfitools-1.36.0-py3-none-any.whl
Size 197.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0b8bfda62a11c0e8fd6747d12ae38c97d9b7aad0ce7171ef62d4eb4af092520f
BLAKE2b-256 checksum
How to use checksums
858d76a5ec99fca221cfe84607a2082a65415875693faab44eb9d784492195c1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 26, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.36.0 This release

2 release files

1.18.0

2 release files

1.15.0

2 release files

1.11.0

2 release files

1.10.0

2 release files

1.7.10

2 release files

1.7.9

2 release files

1.7.7

2 release files

1.7.3

2 release files

1.7.0

2 release files

1.0.0

2 release files

0.17.6

2 release files

0.17.5

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page