Metadata-Version: 2.4
Name: xrtpy
Version: 0.5.1
Summary: For analyzing data from the X-Ray Telescope (XRT) on the Hinode spacecraft.
Author: Will Barnes, Stuart Mumford
Author-email: Joy Velasquez <joy.velasquez@cfa.harvard.edu>, Jonathan Slavin <jslavin@cfa.harvard.edu>, Nick Murpy <namurphy@cfa.harvard.edu>, Nabil Freij <nabil.freij@gmail.com>
License: BSD 2-Clause License
        
        Copyright (c) 2021-2024, XRTpy contributors
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Changelog, https://xrtpy.readthedocs.io/en/stable/changelog/index.html
Project-URL: Documentation, https://xrtpy.readthedocs.io
Project-URL: Issues, https://github.com/HinodeXRT/xrtpy/issues
Project-URL: Repository, https://github.com/HinodeXRT/xrtpy
Keywords: Hinode,Solar Physics,x-ray,XRT
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy>=6
Requires-Dist: matplotlib>=3.7
Requires-Dist: numpy>=1.24
Requires-Dist: scikit-image>=0.21
Requires-Dist: scipy>=1.11.1
Requires-Dist: sunpy[map]>=5.1
Provides-Extra: dev
Requires-Dist: nox>=2024.10.9; extra == "dev"
Provides-Extra: docs
Requires-Dist: astropy>=6; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.15; extra == "docs"
Requires-Dist: setuptools>71.0.1; extra == "docs"
Requires-Dist: sphinx>=7.3; extra == "docs"
Requires-Dist: sphinx-automodapi>=0.17; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5.2; extra == "docs"
Requires-Dist: sphinx-gallery>=0.16; extra == "docs"
Requires-Dist: sphinx-issues>=4.1; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex>=2.6.2; extra == "docs"
Requires-Dist: sphinxext-opengraph>=0.6; extra == "docs"
Requires-Dist: sunpy[map,net]>=5; extra == "docs"
Provides-Extra: tests
Requires-Dist: pytest>=8.3.1; extra == "tests"
Requires-Dist: pytest-astropy>=0.11; extra == "tests"
Requires-Dist: pytest-cov>=6; extra == "tests"
Requires-Dist: pytest-xdist>=3.6.1; extra == "tests"
Dynamic: license-file

<p align="center">
  <a href="https://xrtpy.readthedocs.io/en/stable/">
    <img src="docs/_static/images/XRTpy_logo.png" alt="XRTpy Logo" width="300"/>
  </a>
</p>

# XRTpy

[![License](https://img.shields.io/badge/License-BSD%202--Clause-blue.svg)](./LICENSE)
[![GitHub Actions — CI](https://github.com/HinodeXRT/xrtpy/workflows/CI/badge.svg)](https://github.com/HinodeXRT/xrtpy/actions?query=workflow%3ACI+branch%3Amain)
[![Read the Docs Status](https://readthedocs.org/projects/xrtpy/badge/?version=latest&logo=twitter)](http://xrtpy.readthedocs.io/en/latest/?badge=latest)
[![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat&logo=astropy)](http://www.astropy.org/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13157914.svg)](https://doi.org/10.5281/zenodo.13157914)


XRTpy is a Python package being developed for the analysis of observations made by the X-Ray Telescope (XRT) on the **Hinode** spacecraft.

## Documentation

Check out our full documentation site for examples, installation instructions, and how to get started:
[XRTpy Documentation](https://xrtpy.readthedocs.io/en/latest/)


## Installation

Follow the [installation guide](https://xrtpy.readthedocs.io/en/latest/install.html) to get XRTpy running locally.


## Feedback and Bug Reports

Found an issue or have suggestions? Open an issue on our [GitHub Issues page](https://github.com/HinodeXRT/xrtpy/issues).


## Contributing

We welcome contributions!
See our [Contributing Guide](https://xrtpy.readthedocs.io/en/latest/contributing.html) for how to get started.


## Contact

For general questions, feel free to reach out to us at:
**XRTpy@cfa.harvard.edu**


## Citation

If you use XRTpy in your research, please cite our software:
[DOI: 10.5281/zenodo.13157914](https://doi.org/10.5281/zenodo.13157914)

Velasquez, Joy; Reeves, Katharine; Murphy, Nicholas; Slavin, Jonathan; Weber, Mark; Barnes, Will.
*XRTpy: A Hinode X-Ray Telescope Python Package*.
Journal of Open Source Software, 2024.


## Acknowledgements

The development of XRTpy is supported by NASA contract **NNM07AB07C** to the Smithsonian Astrophysical Observatory.
