Metadata-Version: 2.3
Name: sheap
Version: 0.0.3
Summary: sheap: Spectral Handling and Estimation of AGN Parameters
License: AGPL-3.0-only
Keywords: python package
Author: Felipe Avila-Vera
Author-email: felipe.avilav@postgrado.uv.cl
Maintainer: Felipe Avila-Vera
Maintainer-email: felipe.avilav@postgrado.uv.cl
Requires-Python: >=3.11,<3.13
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Software Distribution
Classifier: Typing :: Typed
Provides-Extra: docs
Provides-Extra: docslive
Provides-Extra: test
Provides-Extra: typing
Requires-Dist: astropy (>=7.0)
Requires-Dist: auto_uncertainties
Requires-Dist: jax (==0.4.35)
Requires-Dist: matplotlib (>=3.9.3)
Requires-Dist: mypy (>=1.8.0,<2.0.0) ; extra == "typing"
Requires-Dist: myst_nb
Requires-Dist: nbsphinx
Requires-Dist: numpy (>=2.2.4)
Requires-Dist: optax (>0.2.3)
Requires-Dist: pandas
Requires-Dist: pytest (>=8.0.0,<9.0.0) ; extra == "test" or extra == "typing"
Requires-Dist: pytest-click (>=1.1.0,<2.0.0) ; extra == "test" or extra == "typing"
Requires-Dist: pytest-cov (>=4.1.0,<5.0.0) ; extra == "test"
Requires-Dist: pytest-explicit (>=1.0.1,<2.0.0) ; extra == "test"
Requires-Dist: pytest-run-subprocess (>=0.10.0,<0.11.0) ; extra == "test"
Requires-Dist: pytest-xdist (>=3.5.0,<4.0.0) ; extra == "test"
Requires-Dist: sfdmap2
Requires-Dist: sphinx (>=5.0,<8.3) ; extra == "docs" or extra == "docslive"
Requires-Dist: sphinx-autobuild (>=2021.3.14,<2022.0.0) ; extra == "docslive"
Requires-Dist: sphinx-autodoc-typehints (>=1.10) ; extra == "docs" or extra == "docslive"
Requires-Dist: sphinx-inline-tabs (>=2023.4.21,<2024.0.0) ; (python_version == "3.12") and (extra == "docs" or extra == "docslive")
Requires-Dist: sphinx-rtd-theme (>=1.2.0,<2.0) ; extra == "docs" or extra == "docslive"
Requires-Dist: sphinxcontrib-mermaid (>=0.9.2,<0.10.0) ; (python_version == "3.12") and (extra == "docs" or extra == "docslive")
Requires-Dist: sphinxcontrib-spelling (>=7.3.3,<7.4.0) ; extra == "docs" or extra == "docslive"
Project-URL: Bug Tracker, https://github.com/sheap/issues
Project-URL: CI: Github Actions, https://github.com/favila/sheap/actions
Project-URL: Changelog, https://github.com/favila/sheap/blob/master/CHANGELOG.rst
Project-URL: Code of Conduct, https://github.com/favila/sheap/blob/master/CONTRIBUTING.rst
Project-URL: Documentation, https://sheap.readthedocs.io/
Project-URL: Homepage, https://github.com/favila/sheap
Project-URL: Repository, https://github.com/favila/sheap
Project-URL: Source Code, https://github.com/favila/sheap
Description-Content-Type: text/x-rst

.. image:: https://raw.githubusercontent.com/felavila/sheap/main/docs/source/_static/sheap_withname.png
   :alt: SHEAP Logo
   :align: left
   :width: 700


Spectral Handling and Estimation of AGN Parameters
=========================================================
|pypi_badge| |docs_badge|

**sheap** is a Python 3 package designed to analyze and estimate key parameters of Active Galactic Nuclei (AGN) from spectral data. This package provides tools to streamline the handling of spectral data and applies models to extract relevant AGN properties efficiently.

Features
========

- **Spectral Fitting**: Automatically fits AGN spectra to estimate key physical parameters.
- **Model Customization**: Allows flexible models for AGN spectra to suit a variety of use cases.
- **AGN Parameter Estimation**: Extract black hole mass from observed spectra.

Installation
============

You can install sheap locally using the following command:

.. code-block:: shell

    pip install -e .

Prerequisites
=============

You need to have Python (>=3.12) and the required dependencies installed. Dependencies are managed using Poetry or can be installed manually via `requirements.txt`.

References
==========

sheap is based on methodologies and models outlined in the following paper:

-  **Mejía-Restrepo, J. E., et al. (2016)**.
   *Active galactic nuclei at z ∼ 1.5 – II. Black hole mass estimation by means of broad emission lines.*
   Monthly Notices of the Royal Astronomical Society, **460**, 187.
   Available at: `ADS Abstract <https://ui.adsabs.harvard.edu/abs/2016MNRAS.460..187M/abstract>`_


License
=======

* `GNU Affero General Public License v3.0 <https://www.gnu.org/licenses/agpl-3.0.html>`_

.. |pypi_badge| image:: https://img.shields.io/pypi/v/sheap.svg
   :alt: PyPI version
   :target: https://pypi.org/project/sheap/

.. |docs_badge| image:: https://readthedocs.org/projects/sheap/badge/?version=latest
   :alt: Documentation Status
   :target: https://sheap.readthedocs.io/en/latest/?badge=latest


