eclipse 0.13.0__tar.gz

eclipse-0.13.0/LICENSE

@@ -0,0 +1,3 @@
+Copyright (c) James McKevitt
+
+The SOLAR-C SWG are required to approve the publication of forward modelling results for SOLAR-C/EUVST. Contact James McKevitt (jm2@mssl.ucl.ac.uk) for more information.

eclipse-0.13.0/MANIFEST.in

@@ -0,0 +1,16 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include src/eclipse *.py
+recursive-include src/euvst_response *.py
+recursive-include src/eclipse/data *
+recursive-include data *
+recursive-exclude data/atmosphere *
+exclude data/gofnt.sav
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude scratch *
+exclude *.pkl
+exclude *.png
+exclude *.out
+exclude job.*

eclipse-0.13.0/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: eclipse
+Version: 0.13.0
+Summary: ECLIPSE: Emission Calculation and Line Prediction for SOLAR-C EUVST
+Author-email: James McKevitt <jm2@mssl.ucl.ac.uk>
+Project-URL: Homepage, https://github.com/jamesmckevitt/eclipse
+Project-URL: Repository, https://github.com/jamesmckevitt/eclipse
+Project-URL: Documentation, https://solarc-eclipse.readthedocs.io
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=2.0
+Requires-Dist: astropy>=6.1.5
+Requires-Dist: ndcube>=2.3
+Requires-Dist: scipy
+Requires-Dist: matplotlib>=3.8.4
+Requires-Dist: joblib>=1.2
+Requires-Dist: tqdm
+Requires-Dist: dill>=0.3.6
+Requires-Dist: pyyaml
+Requires-Dist: reproject>=0.14
+Requires-Dist: sunpy[all]>=6.0
+Requires-Dist: dask>=2024.9.1
+Requires-Dist: psutil
+Requires-Dist: mendeleev
+Requires-Dist: h5py>=3.11
+Requires-Dist: fiasco>=0.5
+Provides-Extra: mpi
+Requires-Dist: mpi4py; extra == "mpi"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: ipywidgets; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocstrings[python]; extra == "docs"
+Requires-Dist: mkdocs-jupyter; extra == "docs"
+Requires-Dist: mkdocs-redirects; extra == "docs"
+Dynamic: license-file
+
+# ECLIPSE: Emission Calculation and Line Prediction for SOLAR-C EUVST
+
+ECLIPSE (Emission Calculation and Line Prediction for SOLAR-C EUVST) predicts what the EUV spectrograph EUVST on SOLAR-C will measure, and how precisely, starting from a model of the solar atmosphere. It also models Hinode/EIS.
+
+Contact: James McKevitt (jm2@mssl.ucl.ac.uk). See [LICENSE](LICENSE) for usage terms.
+
+The instrument model will be updated as EUVST is built, tested and commissioned.
+
+[![Tests](https://github.com/jamesmckevitt/eclipse/actions/workflows/tests.yml/badge.svg)](https://github.com/jamesmckevitt/eclipse/actions/workflows/tests.yml)
+[![Documentation Status](https://app.readthedocs.org/projects/solarc-eclipse/badge/?version=stable)](https://solarc-eclipse.readthedocs.io/)
+[![PyPI](https://img.shields.io/pypi/v/eclipse.svg)](https://pypi.org/project/eclipse/)
+[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.17543844-blue.svg)](https://doi.org/10.5281/zenodo.17543844)
+
+ECLIPSE is installed with `pip install eclipse`. ECLIPSE 0.12 and earlier were on PyPI as `solarc-eclipse`.
+
+The documentation, with installation and a first run, guides to synthesising spectra, simulating the instrument and analysing the results, and a worked example, is at **[solarc-eclipse.readthedocs.io](https://solarc-eclipse.readthedocs.io)**.
+
+## Acknowledgements
+
+The SOLAR-C/EUVST-SW instrument is an ESA-funded contribution to the JAXA-led SOLAR-C mission. The EUVST-LW (long wavelength) instrument is contributed by NASA. The ECLIPSE code is developed and maintained at Mullard Space Science Laboratory (UCL), and was made using Austrian Super Computing (ASC) infrastructure in collaboration with the University of Vienna.

eclipse-0.13.0/README.md

@@ -0,0 +1,20 @@
+# ECLIPSE: Emission Calculation and Line Prediction for SOLAR-C EUVST
+
+ECLIPSE (Emission Calculation and Line Prediction for SOLAR-C EUVST) predicts what the EUV spectrograph EUVST on SOLAR-C will measure, and how precisely, starting from a model of the solar atmosphere. It also models Hinode/EIS.
+
+Contact: James McKevitt (jm2@mssl.ucl.ac.uk). See [LICENSE](LICENSE) for usage terms.
+
+The instrument model will be updated as EUVST is built, tested and commissioned.
+
+[![Tests](https://github.com/jamesmckevitt/eclipse/actions/workflows/tests.yml/badge.svg)](https://github.com/jamesmckevitt/eclipse/actions/workflows/tests.yml)
+[![Documentation Status](https://app.readthedocs.org/projects/solarc-eclipse/badge/?version=stable)](https://solarc-eclipse.readthedocs.io/)
+[![PyPI](https://img.shields.io/pypi/v/eclipse.svg)](https://pypi.org/project/eclipse/)
+[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.17543844-blue.svg)](https://doi.org/10.5281/zenodo.17543844)
+
+ECLIPSE is installed with `pip install eclipse`. ECLIPSE 0.12 and earlier were on PyPI as `solarc-eclipse`.
+
+The documentation, with installation and a first run, guides to synthesising spectra, simulating the instrument and analysing the results, and a worked example, is at **[solarc-eclipse.readthedocs.io](https://solarc-eclipse.readthedocs.io)**.
+
+## Acknowledgements
+
+The SOLAR-C/EUVST-SW instrument is an ESA-funded contribution to the JAXA-led SOLAR-C mission. The EUVST-LW (long wavelength) instrument is contributed by NASA. The ECLIPSE code is developed and maintained at Mullard Space Science Laboratory (UCL), and was made using Austrian Super Computing (ASC) infrastructure in collaboration with the University of Vienna.

eclipse-0.13.0/pyproject.toml

@@ -0,0 +1,90 @@
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "eclipse"
+dynamic = ["version"]
+authors = [
+    {name = "James McKevitt", email = "jm2@mssl.ucl.ac.uk"},
+]
+description = "ECLIPSE: Emission Calculation and Line Prediction for SOLAR-C EUVST"
+readme = "README.md"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Astronomy",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "numpy>=2.0",
+    "astropy>=6.1.5",
+    "ndcube>=2.3",
+    "scipy",
+    "matplotlib>=3.8.4",
+    "joblib>=1.2",
+    "tqdm",
+    "dill>=0.3.6",
+    "pyyaml",
+    "reproject>=0.14",
+    "sunpy[all]>=6.0",
+    "dask>=2024.9.1",
+    "psutil",
+    "mendeleev",
+    "h5py>=3.11",
+    "fiasco>=0.5",
+]
+
+[project.optional-dependencies]
+mpi = [
+    "mpi4py",
+]
+dev = [
+    "pytest",
+    "black",
+    "flake8",
+    "mypy",
+    # Needed when re-running the tutorial notebook, not when building the docs
+    # (mkdocs-jupyter renders the stored outputs without executing anything).
+    # Without it tqdm emits a TqdmWarning, which gets saved into the notebook
+    # outputs and then shows up as an error block on the docs site.
+    "ipywidgets",
+]
+docs = [
+    "mkdocs-material",
+    "mkdocstrings[python]",
+    "mkdocs-jupyter",
+    "mkdocs-redirects",
+]
+
+[project.scripts]
+eclipse = "eclipse.cli:main"
+solarc-eclipse = "eclipse.cli:main"
+synthesise-spectra = "eclipse.synthesis_cli:main"
+synthesise_spectra = "eclipse.synthesis_cli:main"
+eclipse-science-cases = "eclipse.science_cases:main"
+eclipse-atmosphere = "eclipse.atmosphere:main"
+
+[project.urls]
+Homepage = "https://github.com/jamesmckevitt/eclipse"
+Repository = "https://github.com/jamesmckevitt/eclipse"
+Documentation = "https://solarc-eclipse.readthedocs.io"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["eclipse*", "euvst_response"]
+
+[tool.setuptools.dynamic]
+version = {attr = "eclipse.__version__"}
+
+[tool.setuptools.package-data]
+eclipse = ["data/**/*"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]

eclipse-0.13.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

eclipse-0.13.0/src/eclipse/__init__.py

@@ -0,0 +1,95 @@
+"""
+ECLIPSE: Emission Calculation and Line Prediction for SOLAR-C EUVST
+
+Tools for modeling the performance of EUVST, the EUV spectrograph on SOLAR-C.
+"""
+
+__version__ = "0.13.0"
+__author__ = "James McKevitt"
+__email__ = "jm2@mssl.ucl.ac.uk"
+
+# Import main classes and functions for easy access
+from .config import Detector_SWC, Detector_EIS, Telescope_EUVST, Telescope_EIS, Simulation, AluminiumFilter
+from .eis_calibration import effective_area as eis_effective_area
+from .utils import wl_to_vel, vel_to_wl, angle_to_distance, distance_to_angle
+from .radiometric import (
+    intensity_to_photons, add_telescope_throughput, photons_to_pixel_counts,
+    apply_exposure, sample_photon_arrivals, add_poisson, apply_focusing_optics_psf,
+    spatial_psf_fwhm, spectral_psf_fwhm, spectral_line_spread, across_slit_fwhm, to_electrons,
+    to_dn, add_visible_stray_light, add_pinhole_visible_light
+)
+from .pinhole_diffraction import apply_euv_pinhole_diffraction, airy_disk_pattern
+from .fitting import fit_cube_gauss, velocity_from_fit, width_from_fit, analyse, FitConfig, FitComponent
+from .monte_carlo import simulate_once, monte_carlo
+from .main import main
+from .data_processing import load_atmosphere, create_uniform_intensity_cube
+from .atmosphere import (Atmosphere, describe_atmosphere_file, edges_from_centres,
+                         read_atmosphere, write_atmosphere)
+from .synthesis_file import (SpectralLine, Synthesis, convert_synthesis_pickle, load_synthesis,
+                             read_synthesis, read_synthesis_products, write_line_cubes,
+                             write_synthesis)
+from .results_file import convert_results_pickle
+from .band import (BandLines, IonLines, band_contribution_functions, read_band_lines,
+                   write_band_lines)
+from .readout import FocalPlane_SWC, ReadoutSequence
+from .full_frame import FullFrame, full_ccd_frame, write_full_frame
+from .analysis import (
+    load_instrument_response_results,
+    get_parameter_combinations,
+    analyse_fit_statistics,
+    list_fit_components,
+    get_results_for_combination,
+    summary_table,
+    create_sunpy_maps_from_combo,
+)
+from .deprecated import get_dem_data_from_results
+
+__all__ = [
+    "Detector_SWC", "Detector_EIS", "Telescope_EUVST", "Telescope_EIS", 
+    "Simulation", "AluminiumFilter",
+    "eis_effective_area",
+    "wl_to_vel", "vel_to_wl", "angle_to_distance", "distance_to_angle",
+    "intensity_to_photons", "add_telescope_throughput", "photons_to_pixel_counts",
+    "apply_exposure", "sample_photon_arrivals", "add_poisson", "apply_focusing_optics_psf",
+    "spatial_psf_fwhm", "spectral_psf_fwhm", "spectral_line_spread", "across_slit_fwhm",
+    "to_electrons",
+    "to_dn", "add_visible_stray_light", "add_pinhole_visible_light",
+    "fit_cube_gauss", "velocity_from_fit", "width_from_fit", "analyse",
+    "FitConfig", "FitComponent",
+    "simulate_once", "monte_carlo",
+    "main",
+    "load_atmosphere",
+    "create_uniform_intensity_cube",
+    "Atmosphere",
+    "describe_atmosphere_file",
+    "edges_from_centres",
+    "read_atmosphere",
+    "write_atmosphere",
+    "SpectralLine",
+    "Synthesis",
+    "convert_synthesis_pickle",
+    "load_synthesis",
+    "read_synthesis_products",
+    "write_line_cubes",
+    "read_synthesis",
+    "write_synthesis",
+    "convert_results_pickle",
+    "BandLines",
+    "IonLines",
+    "band_contribution_functions",
+    "read_band_lines",
+    "write_band_lines",
+    "FocalPlane_SWC",
+    "ReadoutSequence",
+    "FullFrame",
+    "full_ccd_frame",
+    "write_full_frame",
+    "load_instrument_response_results",
+    "get_parameter_combinations",
+    "analyse_fit_statistics", 
+    "list_fit_components",
+    "get_results_for_combination",
+    "summary_table",
+    "create_sunpy_maps_from_combo",
+    "get_dem_data_from_results"
+]