.. These are examples of badges you might want to add to your README:
please update the URLs accordingly
.. image:: https://api.cirrus-ci.com/github/<USER>/GALFITools.svg?branch=main
:alt: Built Status
:target: https://cirrus-ci.com/github/<USER>/GALFITools
.. image:: https://readthedocs.org/projects/GALFITools/badge/?version=latest
:alt: ReadTheDocs
:target: https://GALFITools.readthedocs.io/en/stable/
.. image:: https://img.shields.io/coveralls/github/<USER>/GALFITools/main.svg
:alt: Coveralls
:target: https://coveralls.io/r/<USER>/GALFITools
.. image:: https://img.shields.io/conda/vn/conda-forge/GALFITools.svg
:alt: Conda-Forge
:target: https://anaconda.org/conda-forge/GALFITools
.. image:: https://pepy.tech/badge/GALFITools/month
:alt: Monthly Downloads
:target: https://pepy.tech/project/GALFITools
.. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter
:alt: Twitter
:target: https://twitter.com/GALFITools
.. image:: https://img.shields.io/pypi/v/GALFITools.svg
:alt: PyPI-Server
:target: https://pypi.org/project/GALFITools/
.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold
:alt: Project generated with PyScaffold
:target: https://pyscaffold.org/
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8216472.svg
:target: https://doi.org/10.5281/zenodo.8216472
.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
:target: CODE_OF_CONDUCT.md
.. image:: https://www.repostatus.org/badges/latest/active.svg
:alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.
:target: https://www.repostatus.org/#active
.. image:: https://github.com/canorve/galfitools/actions/workflows/run-test.yml/badge.svg
:target: https://github.com/canorve/galfitools/actions/workflows/run-test.yml
:alt: Build Status
.. image:: https://codecov.io/gh/canorve/galfitools/branch/master/graph/badge.svg
:target: https://codecov.io/gh/canorve/galfitools
:alt: Coverage
.. image:: https://img.shields.io/pypi/pyversions/your-package.svg
:target: https://pypi.org/project/your-package/
:alt: Supported Python versions
============
GALFITools
============
`GALFIT <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 <GALFIT2_>`_ webpage.
The DS9 webpage can be found `here <ds9_>`_ and a basic tutorial `here <ds9_tutorial_>`_.
Useful concepts with related functions and CLI commands can be found
`here <https://galfitools.readthedocs.io/en/latest/concepts.html>`_.
.. _GALFIT: https://users.obs.carnegiescience.edu/peng/work/galfit/GFAQ.html
.. _GALFIT2: https://users.obs.carnegiescience.edu/peng/work/galfit/galfit.html
.. _ds9: https://sites.google.com/cfa.harvard.edu/saoimageds9
.. _ds9_tutorial: https://astrobites.org/2011/03/09/how-to-use-sao-ds9-to-examine-astronomical-images
-----------------------------------
**Installation Instructions**
-----------------------------------
First of all, install `GALFIT`_ if you haven't done so. Check
instructions `here <https://raw.githubusercontent.com/canorve/GALFITools/refs/heads/master/docs/README.INSTALL>`__.
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 <https://users.obs.carnegiescience.edu/peng/work/galfit/README.pdf>`__.
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:: https://img.youtube.com/vi/rqZLxR1yRCs/maxresdefault.jpg
:alt: IMAGE ALT TEXT HERE
:target: https://www.youtube.com/watch?v=rqZLxR1yRCs
------------------------------------
**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 <https://raw.githubusercontent.com/canorve/GALFITools/refs/heads/master/docs/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/ <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 <https://github.com/canorve/GALFITools/issues>`__.
Your input is invaluable in fostering the continual refinement of
GALFITools, for the betterment of the *GALFIT* community and beyond.
- Issue tracker: `https://github.com/canorve/GALFITools/issues <https://github.com/canorve/GALFITools/issues>`__.
- Source code: `https://github.com/canorve/GALFITools <https://github.com/canorve/GALFITools>`__.
- `Contributions and help <https://galfitools.readthedocs.io/en/latest/contributing.html>`__.
--------------
**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,
we kindly request that you cite it as follows:
Añorve, C. (2024). canorve/GALFITools: GALFITools v1.15.0 (v1.15.0).
Zenodo. https://doi.org/10.5281/zenodo.13994492
cite all versions using the DOI: https://doi.org/10.5281/zenodo.8216472
--------------------------
**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 <https://github.com/canorve/EllipSect>`__
.. _pyscaffold-notes:
====
Note
~~~~~~
This project has been set up using PyScaffold 4.2.1. For details and usage
information on PyScaffold see https://pyscaffold.org/.
Raw data
{
"_id": null,
"home_page": "https://github.com/canorve/GALFITools",
"name": "GALFITools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Christopher A\u00f1orve",
"author_email": "canorve@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/46/ad/d924ec511237606709f02021034c6ca63f9b2376c15d0846c6c39cb5d2aa/galfitools-1.18.0.tar.gz",
"platform": "Mac",
"description": ".. These are examples of badges you might want to add to your README:\n please update the URLs accordingly\n\n .. image:: https://api.cirrus-ci.com/github/<USER>/GALFITools.svg?branch=main\n :alt: Built Status\n :target: https://cirrus-ci.com/github/<USER>/GALFITools\n .. image:: https://readthedocs.org/projects/GALFITools/badge/?version=latest\n :alt: ReadTheDocs\n :target: https://GALFITools.readthedocs.io/en/stable/\n .. image:: https://img.shields.io/coveralls/github/<USER>/GALFITools/main.svg\n :alt: Coveralls\n :target: https://coveralls.io/r/<USER>/GALFITools\n .. image:: https://img.shields.io/conda/vn/conda-forge/GALFITools.svg\n :alt: Conda-Forge\n :target: https://anaconda.org/conda-forge/GALFITools\n .. image:: https://pepy.tech/badge/GALFITools/month\n :alt: Monthly Downloads\n :target: https://pepy.tech/project/GALFITools\n .. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter\n :alt: Twitter\n :target: https://twitter.com/GALFITools\n\n.. image:: https://img.shields.io/pypi/v/GALFITools.svg\n :alt: PyPI-Server\n :target: https://pypi.org/project/GALFITools/\n\n.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold\n :alt: Project generated with PyScaffold\n :target: https://pyscaffold.org/\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8216472.svg \n :target: https://doi.org/10.5281/zenodo.8216472 \n\n.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg \n :target: CODE_OF_CONDUCT.md \n\n.. image:: https://www.repostatus.org/badges/latest/active.svg\n :alt: Project Status: Active \u2013 The project has reached a stable, usable state and is being actively developed.\n :target: https://www.repostatus.org/#active\n\n\n.. image:: https://github.com/canorve/galfitools/actions/workflows/run-test.yml/badge.svg\n :target: https://github.com/canorve/galfitools/actions/workflows/run-test.yml\n :alt: Build Status\n\n.. image:: https://codecov.io/gh/canorve/galfitools/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/canorve/galfitools\n :alt: Coverage\n\n.. image:: https://img.shields.io/pypi/pyversions/your-package.svg\n :target: https://pypi.org/project/your-package/\n :alt: Supported Python versions\n\n============\nGALFITools\n============\n\n`GALFIT <GALFIT_>`_, a well-established two-dimensional image fitting algorithm, \nas outlined in the work by Peng et al. (2002, AJ, 124, 266), \nserves as the basis for precise astronomical image surface brightness \nanalysis. In pursuit of optimizing the utilization of GALFIT, GALFITools emerges \nas an collection of Python routines. These routines \nenhances the input and output parsing associated with GALFIT.\n\n\nGALFITools extends its utility through an array of functionalities, \nincluding the facilitation of mask creation, star selection for PSFs, generation \nof multiple initial parameters, simulate galaxy images, multigaussian \nexpansion (MGE) fitting, as well as computation of sky background \nand other pertinent photometric variables.\n\n\n**NOTE:** GALFITools assumes the user has a basic knowledge of GALFIT and SaoImage DS9. \nHow to use GALFIT is found in the official `GALFIT <GALFIT2_>`_ webpage. \nThe DS9 webpage can be found `here <ds9_>`_ and a basic tutorial `here <ds9_tutorial_>`_.\nUseful concepts with related functions and CLI commands can be found \n`here <https://galfitools.readthedocs.io/en/latest/concepts.html>`_.\n\n\n.. _GALFIT: https://users.obs.carnegiescience.edu/peng/work/galfit/GFAQ.html\n.. _GALFIT2: https://users.obs.carnegiescience.edu/peng/work/galfit/galfit.html\n.. _ds9: https://sites.google.com/cfa.harvard.edu/saoimageds9\n.. _ds9_tutorial: https://astrobites.org/2011/03/09/how-to-use-sao-ds9-to-examine-astronomical-images\n\n\n\n-----------------------------------\n\n**Installation Instructions**\n-----------------------------------\n\nFirst of all, install `GALFIT`_ if you haven't done so. Check\ninstructions `here <https://raw.githubusercontent.com/canorve/GALFITools/refs/heads/master/docs/README.INSTALL>`__.\nMake sure that GALFIT can run in any path in your *linux/macOS* terminal.\n\nIf you want to learn how to use GALFIT, click `here <https://users.obs.carnegiescience.edu/peng/work/galfit/README.pdf>`__.\n\nGALFITools supports Python 3.9 through 3.13. \n*Optionally*, we recommend using a virtual environment\n\nInstall GALFITools via pip:\n\n::\n\n pip install GALFITools \n\n\nHere is a detailed video tutorial on installing GALFITools \nusing a virtual environment created with Conda:\n\n\n.. image:: https://img.youtube.com/vi/rqZLxR1yRCs/maxresdefault.jpg\n :alt: IMAGE ALT TEXT HERE\n :target: https://www.youtube.com/watch?v=rqZLxR1yRCs\n\n\n\n------------------------------------\n\n**Get Started with GALFITools**\n-----------------------------------\n\nOnce installed, you can test GALFITools using any of \nthe commands in the console. \n\nIn the example below, the command *getReComp* is executed in a terminal \nusing the GALFIT output file \n`galfit.01 <https://raw.githubusercontent.com/canorve/GALFITools/refs/heads/master/docs/galfit.01>`__ to \ncalculate the effective radius of a model \nwith three Sersic components:\n\n::\n \n $ getReComp galfit.01\n GALFITools: a library for GALFIT\n Version: 1.14.1\n webpage: https://github.com/canorve/GALFITools\n\n number of model components: 3\n Using a theta value of : 14.13 degrees \n\n Total Magnitude of the galaxy: 9.79 \n\n Surface brightness at radius of 50% of light (\u03bcr): 21.15 mag/'' \n\n Mean Surface Brightness at effective radius (<\u03bc>e): 20.27 mag/'' \n\n The radius at 50% of light is 199.64 pixels or 49.91 \" \n\n\n-------------------\n\n**Documentation**\n-------------------\n\nFull documentation along usage guide can be found in `https://galfitools.readthedocs.io/en/latest/ <https://galfitools.readthedocs.io/en/latest/>`__.\n\n\n\n------------------------------\n\n**Contributing and Support**\n-------------------------------\n\nLet us know if you have issues, questions or innovative suggestions arise, \nwe encourage you to reach out via email to canorve [at] gmail [dot] com \nor initiate a discussion by opening an `issue <https://github.com/canorve/GALFITools/issues>`__. \nYour input is invaluable in fostering the continual refinement of \nGALFITools, for the betterment of the *GALFIT* community and beyond.\n\n\n- Issue tracker: `https://github.com/canorve/GALFITools/issues <https://github.com/canorve/GALFITools/issues>`__. \n\n- Source code: `https://github.com/canorve/GALFITools <https://github.com/canorve/GALFITools>`__. \n\n- `Contributions and help <https://galfitools.readthedocs.io/en/latest/contributing.html>`__. \n\n\n--------------\n\n**License**\n--------------\n\nThe codebase of GALFITools is governed by the terms of the **MIT** license.\n\n\n----------------------\n\n**Credit / Citation**\n-----------------------\n\nIf you find this code useful in your research, \nwe kindly request that you cite it as follows:\n\nA\u00f1orve, C. (2024). canorve/GALFITools: GALFITools v1.15.0 (v1.15.0). \nZenodo. https://doi.org/10.5281/zenodo.13994492\n\n\ncite all versions using the DOI: https://doi.org/10.5281/zenodo.8216472\n\n\n\n--------------------------\n\n**Additonal Resources**\n--------------------------\n\n\nFor further capabilities and valuable extensions \npertaining to GALFIT output, such as the generation of \nsurface brightness profiles and estimation of other \nphotometric parameters, we invite you to explore the \nEllipSect tool: \n\n`EllipSect <https://github.com/canorve/EllipSect>`__\n\n\n.. _pyscaffold-notes:\n\n\n====\n\nNote\n~~~~~~\n\nThis project has been set up using PyScaffold 4.2.1. For details and usage\ninformation on PyScaffold see https://pyscaffold.org/.\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library for GALFIT package",
"version": "1.18.0",
"project_urls": {
"Documentation": "https://pyscaffold.org/",
"GALFIT": "https://users.obs.carnegiescience.edu/peng/work/galfit/galfit.html",
"Homepage": "https://github.com/canorve/GALFITools",
"Source": "https://github.com/canorve/GALFITools"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f42c9bc8b6e688e8d0fd97e935bd513f7af4aceb6eec67020a6df2712b9a8105",
"md5": "a5b711c9e233bc3f73e3a2013faa7689",
"sha256": "d6e96b82f9ba930b3c9d68d6948ddb773aa5b40fb88a0a7c01217c1ed5ebe6b0"
},
"downloads": -1,
"filename": "galfitools-1.18.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a5b711c9e233bc3f73e3a2013faa7689",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 102349,
"upload_time": "2025-08-30T23:32:43",
"upload_time_iso_8601": "2025-08-30T23:32:43.659611Z",
"url": "https://files.pythonhosted.org/packages/f4/2c/9bc8b6e688e8d0fd97e935bd513f7af4aceb6eec67020a6df2712b9a8105/galfitools-1.18.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "46add924ec511237606709f02021034c6ca63f9b2376c15d0846c6c39cb5d2aa",
"md5": "54ef8d5b52d2d67c594e98eba574cc98",
"sha256": "1995f560675f32d4675bd51429180878ce91ddfcff2b5c9e7b4b413f66aa2025"
},
"downloads": -1,
"filename": "galfitools-1.18.0.tar.gz",
"has_sig": false,
"md5_digest": "54ef8d5b52d2d67c594e98eba574cc98",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 25959103,
"upload_time": "2025-08-30T23:32:47",
"upload_time_iso_8601": "2025-08-30T23:32:47.714462Z",
"url": "https://files.pythonhosted.org/packages/46/ad/d924ec511237606709f02021034c6ca63f9b2376c15d0846c6c39cb5d2aa/galfitools-1.18.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-30 23:32:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "canorve",
"github_project": "GALFITools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "galfitools"
}
JSON
