Metadata-Version: 2.4
Name: helio-foxes
Version: 2.0.1
Summary: FOXES: Framework for Operational X-ray Emission Synthesis
License: MIT License
        
        Copyright (c) 2026 Frontier Development Lab
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://griffin-goodwin.github.io/FOXES/
Project-URL: Source, https://github.com/griffin-goodwin/FOXES
Project-URL: Issues, https://github.com/griffin-goodwin/FOXES/issues
Project-URL: Releases, https://github.com/griffin-goodwin/FOXES/releases
Project-URL: Demo, https://huggingface.co/spaces/griffingoodwin04/FOXES-model
Project-URL: Dataset, https://huggingface.co/datasets/griffingoodwin04/FOXES-Data
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: torch
Requires-Dist: pytorch-lightning
Requires-Dist: pandas
Requires-Dist: python-dateutil
Requires-Dist: tqdm
Requires-Dist: PyYAML
Requires-Dist: matplotlib
Requires-Dist: drms
Requires-Dist: astropy<8,>=7.2
Requires-Dist: sunpy[map,net,timeseries]>=6
Requires-Dist: h5netcdf
Requires-Dist: h5py
Requires-Dist: itipy
Requires-Dist: aiapy<0.11,>=0.6.4
Provides-Extra: evaluation
Requires-Dist: scikit-learn; extra == "evaluation"
Requires-Dist: seaborn; extra == "evaluation"
Requires-Dist: plotly; extra == "evaluation"
Provides-Extra: training
Requires-Dist: wandb; extra == "training"
Requires-Dist: torchvision; extra == "training"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ipykernel; extra == "dev"
Requires-Dist: nbformat; extra == "dev"
Requires-Dist: matplotlib==3.10.7; extra == "dev"
Dynamic: license-file

---
license: mit
task_categories:
  - image-to-image
  - time-series-forecasting
tags:
  - solar
  - heliophysics
  - astronomy
  - AIA
  - SDO
  - EUV
  - SXR
  - GOES
  - flare
  - space-weather
pretty_name: "FOXES: Framework for Operational X-ray Emission Synthesis"
size_categories:
  - 100K<n<1M
language:
  - en
datasets:
  - griffingoodwin04/FOXES-Data
---

# FOXES: Framework for Operational X-ray Emission Synthesis

<p align="center">
  <img src="https://media.githubusercontent.com/media/griffin-goodwin/FOXES/main/foxes_logo.png" alt="FOXES Logo" width="300"/>
</p>

FOXES predicts full-disk solar soft X-ray flux and spatial patch contributions
from seven-channel SDO/AIA images. This repository includes the Python package,
data tools, training code, and evaluation workflows.

**[Read the Sphinx documentation](https://griffin-goodwin.github.io/FOXES/)**
for getting started, checkpoint downloads, examples, results, and the API reference.

## Install

```bash
python -m pip install helio-foxes
```

Import the package as `helio_foxes`. Model checkpoints are downloaded separately;
follow the [getting started guide](https://griffin-goodwin.github.io/FOXES/python_api.html)
for your first prediction.

[Notebook walkthrough](https://github.com/griffin-goodwin/FOXES/blob/main/tutorials/heliofoxes_demo/heliofoxes.ipynb) ·
[Model demo](https://huggingface.co/spaces/griffingoodwin04/FOXES-model) ·
[Dataset](https://huggingface.co/datasets/griffingoodwin04/FOXES-Data)

## Citation

If you use this code or data in your work, please cite:

```bibtex
@software{FOXES,
    title           = {{FOXES: A Framework For Operational X-ray Emission Synthesis}},
    institution     = {Frontier Development Lab (FDL)},
    repository-code = {https://github.com/griffin-goodwin/FOXES},
    version         = {v1.0},
    year            = {2026}
}
```

## Acknowledgement

This work is a research product of Heliolab (heliolab.ai), an initiative of the Frontier Development Lab (FDL.ai). FDL is a public–private partnership between NASA, Trillium Technologies (trillium.tech), and commercial AI partners including Google Cloud and NVIDIA.
Heliolab was designed, delivered, and managed by Trillium Technologies Inc., a research and development company focused on intelligent systems and collaborative communities for Heliophysics, planetary stewardship and space exploration.
We gratefully acknowledge Google Cloud for extensive computational resources and NVIDIA Corporation.
This material is based upon work supported by NASA under award number No. 80GSFC23CA040. Any opinions, findings, conclusions or recommendations expressed are those of the authors and do not necessarily reflect the views of the National Aeronautics and Space Administration.

Large language models were used as brainstorming tools to discuss possible training strategies and methodological considerations. The authors retained full responsibility for all research decisions, interpretations, and conclusions presented in this work.
