.. 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
==========
GALFITools
==========
A library for `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.
.. _GALFIT: https://users.obs.carnegiescience.edu/peng/work/galfit/galfit.html
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.
--------------------------------
**Installation Instructions**
-------------------------------
The python libraries required are:
- numpy
- astropy
- scipy
- matplotlib
- mgefit
Install `GALFIT`_ if you haven't done so. Make sure
that GALFIT can run in any path in your terminal.
*Optionally*, the establishment of a virtual environment can be considered.
The latest release of GALFITools can be downloaded
and subsequently installed via one of the following methods:
::
cd GALFITools
pip install .
or
::
cd GALFITools
python setup.py install
Alternatively, you can install it via pip:
::
pip install GALFITools
In conjunction with the installation, a compilation of pertinent
shell `commands <docs/howto.rst>`__ will be incorporated. Subsequently, a comprehensive
evaluation of GALFITools' performance can be conducted through
automated tests using the following procedure:
To run the tests locally, install and invoke tox:
::
pip install tox
run the tests:
::
tox
-----------------
**HOW TO USE**
~~~~~~~~~~~~~~~~~
For comprehensive insights into GALFITools' repertoire
of routines and their optimal deployment, it is
recommended to consult the provided documentation on
usage, accessible via the following link:
`How to use <docs/howto.rst>`__
This comprehensive resource elaborates on the
practical implementation of each individual routine.
---------------------
**API Reference**
~~~~~~~~~~~~~~~~~~~~
For the customization of these functions
to align with your specific scripting requirements,
the API documentation serves as an indispensable resource.
The detailed instructions for utilizing these
functions within your own scripts can be found here:
`API <docs/api.rst>`__
--------------
**License**
--------------
The codebase of GALFITools is governed by the terms of the **MIT** license.
-----------
**Cite as**
-----------
To acknowledge the utility of GALFITools in your research,
we kindly request that you cite it as follows:
Añorve, C. (2024). canorve/GALFITools: GALFITools v1.7.0 (v1.7.0). Zenodo. https://doi.org/10.5281/zenodo.10968602
--------------------------
**Additional Resources**
--------------------------
Check EllipSect to create surface brightness profiles
from GALFIT output and estimate other photometric parameters:
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>`__
--------------
**Questions?**
--------------
Should any 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.
.. _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/pyscaffold/pyscaffold/",
"name": "GALFITools",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Christopher A\u00f1orve",
"author_email": "canorve@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4b/26/6dedf2754c69b44b30ad0ef23a12a2d165e325e62628612d51c13e8f95f2/galfitools-1.7.7.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\n==========\nGALFITools\n==========\n\n\nA library for `GALFIT`_ \n\n`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\n\n.. _GALFIT: https://users.obs.carnegiescience.edu/peng/work/galfit/galfit.html\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\n\n--------------------------------\n\n**Installation Instructions**\n-------------------------------\n\n\n\nThe python libraries required are:\n\n- numpy\n- astropy\n- scipy\n- matplotlib\n- mgefit\n\n\n\nInstall `GALFIT`_ if you haven't done so. Make sure\nthat GALFIT can run in any path in your terminal.\n\n\n*Optionally*, the establishment of a virtual environment can be considered.\n\n\nThe latest release of GALFITools can be downloaded \nand subsequently installed via one of the following methods:\n\n\n::\n\n cd GALFITools \n pip install . \n\nor\n\n::\n\n cd GALFITools \n python setup.py install\n\n\nAlternatively, you can install it via pip:\n\n\n::\n\n pip install GALFITools \n\n\n\n\nIn conjunction with the installation, a compilation of pertinent \nshell `commands <docs/howto.rst>`__ will be incorporated. Subsequently, a comprehensive \nevaluation of GALFITools' performance can be conducted through \nautomated tests using the following procedure:\n\nTo run the tests locally, install and invoke tox:\n\n::\n \n pip install tox\n\n\nrun the tests:\n\n::\n\n tox \n\n\n\n-----------------\n\n**HOW TO USE**\n~~~~~~~~~~~~~~~~~\n\nFor comprehensive insights into GALFITools' repertoire \nof routines and their optimal deployment, it is \nrecommended to consult the provided documentation on \nusage, accessible via the following link: \n\n`How to use <docs/howto.rst>`__\n\nThis comprehensive resource elaborates on the \npractical implementation of each individual routine.\n\n---------------------\n\n**API Reference**\n~~~~~~~~~~~~~~~~~~~~\n\n\nFor the customization of these functions \nto align with your specific scripting requirements, \nthe API documentation serves as an indispensable resource. \nThe detailed instructions for utilizing these \nfunctions within your own scripts can be found here: \n\n`API <docs/api.rst>`__\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**Cite as**\n-----------\n\nTo acknowledge the utility of GALFITools in your research, \nwe kindly request that you cite it as follows:\n\nA\u00f1orve, C. (2024). canorve/GALFITools: GALFITools v1.7.0 (v1.7.0). Zenodo. https://doi.org/10.5281/zenodo.10968602\n\n\n--------------------------\n\n**Additional Resources**\n--------------------------\n\nCheck EllipSect to create surface brightness profiles\nfrom GALFIT output and estimate other photometric parameters:\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\n--------------\n\n**Questions?**\n--------------\n\n\nShould any 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\n\n.. _pyscaffold-notes:\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library for GALFIT package",
"version": "1.7.7",
"project_urls": {
"Documentation": "https://pyscaffold.org/",
"GALFIT": "https://users.obs.carnegiescience.edu/peng/work/galfit/galfit.html",
"Homepage": "https://github.com/pyscaffold/pyscaffold/",
"Source": "https://github.com/canorve/GALFITools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3475463548cb89caacc6db5083c73007b0f9f9fa1e2402fa2a6fdaa49ef9763",
"md5": "7766dddb298a8a6dd12d90e21fabda5d",
"sha256": "47a1980664b3aa26def2ec66bdfad44839b329bb5d4def09db139ebdab6b6faf"
},
"downloads": -1,
"filename": "GALFITools-1.7.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7766dddb298a8a6dd12d90e21fabda5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 103437,
"upload_time": "2024-05-16T23:33:36",
"upload_time_iso_8601": "2024-05-16T23:33:36.712048Z",
"url": "https://files.pythonhosted.org/packages/d3/47/5463548cb89caacc6db5083c73007b0f9f9fa1e2402fa2a6fdaa49ef9763/GALFITools-1.7.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b266dedf2754c69b44b30ad0ef23a12a2d165e325e62628612d51c13e8f95f2",
"md5": "3c9bf0e7872696674ab3eb01b95ecc72",
"sha256": "6974c900e0715fa6c4be232218c45c1e228ded604f27e9cb24c24188f396b54a"
},
"downloads": -1,
"filename": "galfitools-1.7.7.tar.gz",
"has_sig": false,
"md5_digest": "3c9bf0e7872696674ab3eb01b95ecc72",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25782448,
"upload_time": "2024-05-16T23:33:41",
"upload_time_iso_8601": "2024-05-16T23:33:41.434052Z",
"url": "https://files.pythonhosted.org/packages/4b/26/6dedf2754c69b44b30ad0ef23a12a2d165e325e62628612d51c13e8f95f2/galfitools-1.7.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-16 23:33:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyscaffold",
"github_project": "pyscaffold",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "galfitools"
}
JSON
