solarc-eclipse 0.6.1__tar.gz → 0.6.2__tar.gz

{solarc_eclipse-0.6.1/solarc_eclipse.egg-info → solarc_eclipse-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: solarc-eclipse
-Version: 0.6.1
+Version: 0.6.2
 Summary: ECLIPSE: Emission Calculation and Line Prediction for SOLAR-C EUVST
 Home-page: https://github.com/jamesmckevitt/eclipse
 Author: James McKevitt
@@ -88,6 +88,7 @@ eclipse --help
 You can also use ECLIPSE as a Python library:
 
 ```python
+import astropy.units as u
 import euvst_response
 from euvst_response import AluminiumFilter, Detector_SWC, Telescope_EUVST
 
@@ -117,7 +118,7 @@ For analyzing simulation results, see the included Jupyter notebook `analysis_tu
 - Analyze fit statistics and compute velocity/line width errors
 - Create SunPy maps for visualization
 
-The analysis functions are now available directly from the package:
+The analysis functions are available directly from the package:
 
 ```python
 from euvst_response import (
@@ -127,6 +128,15 @@ from euvst_response import (
     create_sunpy_maps_from_combo,
     summary_table
 )
+
+# Load results
+results = load_instrument_response_results("run/result/my_run.pkl")
+
+# Print a summary table (auto-discovers all parameters and shows git commit)
+summary_table(results)
+
+# Retrieve a specific combination using full section.attribute names
+combo = get_results_for_combination(results, **{"simulation.expos": 40*u.s, "simulation.psf": True})
 ```
 
 ## Detailed instructions
@@ -306,61 +316,66 @@ This step can require a lot of memory at full resolution. A fully synthesised at
 
 #### Configuration File
 
-ECLIPSE uses YAML configuration files to specify simulation parameters. You can specify single values or lists of values for parameter sweeps.
-
-**Key configuration options:**
-- `instrument`: Choose between SWC (EUVST-SW) or EIS (Hinode)
-- `synthesis_file`: Path to the synthesised spectra pickle file (default: `./run/input/synthesised_spectra.pkl`)
-- `reference_line`: Spectral line to use as reference for wavelength grid when combining all lines (default: `Fe12_195.1190`)
-- `expos`: Exposure time(s) for simulations
-- `n_iter`: Number of Monte Carlo iterations
-- Parameter sweeps for filters, detector settings, etc.
+ECLIPSE uses YAML configuration files to specify simulation parameters.
+Parameters are organised into four sections - `simulation`, `detector`, `telescope`, and `filter` - each corresponding directly to a configuration class in `config.py`.
+Any field of those classes can be set here.
+**Any parameter that is given as a list is automatically swept over** and the
+simulation runs every combination (cartesian product).
+
+**Top-level keys** (not sections):
+- `instrument`: `SWC` (EUVST Short Wavelength) or `EIS` (Hinode/EIS)
+- `synthesis_file`: path to the synthesised spectra pickle file
+- `reference_line`: spectral line used as the wavelength-grid reference (default `Fe12_195.1190`)
+- `n_iter`: number of Monte Carlo iterations
+- `ncpu`: CPU cores to use (`-1` = all available)
+- `pinhole_sizes`, `pinhole_positions`: fixed paired lists for pinhole diffraction tests (SWC only)
+- `uniform_intensity`, `rest_wavelength`, `thermal_width`: uniform-intensity mode (alternative to synthesis file)
 
 Here's a complete example configuration file:
 
 ```yaml
-# Instrument selection
-instrument: SWC  # Options: SWC (EUVST Short Wavelength) or EIS (Hinode/EIS)
-
-# Synthesis file path - location of the synthesised spectra pickle file
-synthesis_file: ./run/input/synthesised_spectra.pkl  # Default location
-
-# Reference line for wavelength grid and metadata when combining all spectral lines
-reference_line: Fe12_195.1190  # Default reference line (Fe XII 195.119 Å)
-
-# Point Spread Function
-psf: False  # Enable PSF convolution
-# Or test with and without PSF:
-# psf: [True, False]  # Run simulations both with and without PSF
-
-# Exposure times - can be single value or list
-expos: [0.5 s, 1 s, 2 s, 5 s, 10 s, 20 s, 40 s, 80 s]
-
-# Monte Carlo simulation parameters
-n_iter: 1000      # Number of Monte Carlo iterations
-ncpu: -1        # Number of CPU cores (-1 = use all available)
-
-# Parameter sweeps - you can specify single values or lists for any parameter
-# The simulation will run all combinations of parameters
-
-# Slit width
-slit_width: 0.2 arcsec  # Narrowest slit on EUVST
-
-# Filter parameters (SWC only)
-# Thickness of aluminum oxide layer on entrance filter
-oxide_thickness: 95 angstrom  # Default (expected value)
-
-# Carbon contamination thickness on filter
-c_thickness: 0 angstrom  # Default (ideal case, no contamination)
-
-# Aluminum filter thickness
-aluminium_thickness: 1485 angstrom  # Default (expected value)
+# Input
+instrument: SWC
+synthesis_file: ./run/input/synthesised_spectra.pkl
+reference_line: Fe12_195.1190
+
+# Global settings (apply to all combinations)
+n_iter: 500
+ncpu: -1
+
+# Simulation parameters
+# Any field listed as a list is swept over; all combinations are run.
+simulation:
+  slit_width: [0.2 arcsec, 0.4 arcsec]  # sweep over two slit widths
+  expos: [5 s, 10 s, 20 s, 40 s, 80 s]  # sweep over five exposure times
+  psf: True
+  vis_sl: 0 photon / (s * cm^2)
+  enable_pinholes: False
+
+# Detector parameters
+detector:
+  ccd_temperature: -60 Celsius  # used to compute dark current via the CCD model
+
+# Telescope parameters
+telescope:
+  microroughness_sigma: 0.3 nm  # RMS surface roughness
+
+# Aluminium filter parameters (SWC only)
+filter:
+  al_thickness: 1485 angstrom
+  oxide_thickness: 95 angstrom
+  c_thickness: 40 angstrom
+  mesh_throughput: 0.8
+```
 
-# CCD temperature for dark current calculation
-ccd_temperature: -60 Celsius  # Default (expected operating temperature)
+Any parameter from the `Detector_SWC`, `Telescope_EUVST`, or `AluminiumFilter`
+dataclasses in `config.py` can be added to the corresponding section. For
+example, to sweep over detector quantum efficiency:
 
-# Visible stray light level
-vis_sl: 0 photon / (s * pixel)  # Default, (ideal case, no stray light)
+```yaml
+detector:
+  ccd_temperature: -60 Celsius
+  qe_euv: [0.5, 0.65, 0.76]   # sweep over three QE values
 ```
 
 For guidance on recommended values, see McKevitt et al. (2025) (in prep.).
@@ -387,6 +402,10 @@ Results are saved as pickle files in the `run/result/` directory with the same b
 - Fitted spectral line parameters (intensity, velocity, width)
 - Statistical analysis of velocity precision vs. exposure time
 - Ground truth comparisons
+- Full config objects (`Detector`, `Telescope`, `Simulation`) for each parameter combination
+- The git commit ID and software version used to produce the results
+
+Use `summary_table(results)` after loading to see all parameter combinations and the run metadata.
 
 ## Acknowledgements
 

{solarc_eclipse-0.6.1 → solarc_eclipse-0.6.2}/README.md

@@ -45,6 +45,7 @@ eclipse --help
 You can also use ECLIPSE as a Python library:
 
 ```python
+import astropy.units as u
 import euvst_response
 from euvst_response import AluminiumFilter, Detector_SWC, Telescope_EUVST
 
@@ -74,7 +75,7 @@ For analyzing simulation results, see the included Jupyter notebook `analysis_tu
 - Analyze fit statistics and compute velocity/line width errors
 - Create SunPy maps for visualization
 
-The analysis functions are now available directly from the package:
+The analysis functions are available directly from the package:
 
 ```python
 from euvst_response import (
@@ -84,6 +85,15 @@ from euvst_response import (
     create_sunpy_maps_from_combo,
     summary_table
 )
+
+# Load results
+results = load_instrument_response_results("run/result/my_run.pkl")
+
+# Print a summary table (auto-discovers all parameters and shows git commit)
+summary_table(results)
+
+# Retrieve a specific combination using full section.attribute names
+combo = get_results_for_combination(results, **{"simulation.expos": 40*u.s, "simulation.psf": True})
 ```
 
 ## Detailed instructions
@@ -263,61 +273,66 @@ This step can require a lot of memory at full resolution. A fully synthesised at
 
 #### Configuration File
 
-ECLIPSE uses YAML configuration files to specify simulation parameters. You can specify single values or lists of values for parameter sweeps.
-
-**Key configuration options:**
-- `instrument`: Choose between SWC (EUVST-SW) or EIS (Hinode)
-- `synthesis_file`: Path to the synthesised spectra pickle file (default: `./run/input/synthesised_spectra.pkl`)
-- `reference_line`: Spectral line to use as reference for wavelength grid when combining all lines (default: `Fe12_195.1190`)
-- `expos`: Exposure time(s) for simulations
-- `n_iter`: Number of Monte Carlo iterations
-- Parameter sweeps for filters, detector settings, etc.
+ECLIPSE uses YAML configuration files to specify simulation parameters.
+Parameters are organised into four sections - `simulation`, `detector`, `telescope`, and `filter` - each corresponding directly to a configuration class in `config.py`.
+Any field of those classes can be set here.
+**Any parameter that is given as a list is automatically swept over** and the
+simulation runs every combination (cartesian product).
+
+**Top-level keys** (not sections):
+- `instrument`: `SWC` (EUVST Short Wavelength) or `EIS` (Hinode/EIS)
+- `synthesis_file`: path to the synthesised spectra pickle file
+- `reference_line`: spectral line used as the wavelength-grid reference (default `Fe12_195.1190`)
+- `n_iter`: number of Monte Carlo iterations
+- `ncpu`: CPU cores to use (`-1` = all available)
+- `pinhole_sizes`, `pinhole_positions`: fixed paired lists for pinhole diffraction tests (SWC only)
+- `uniform_intensity`, `rest_wavelength`, `thermal_width`: uniform-intensity mode (alternative to synthesis file)
 
 Here's a complete example configuration file:
 
 ```yaml
-# Instrument selection
-instrument: SWC  # Options: SWC (EUVST Short Wavelength) or EIS (Hinode/EIS)
-
-# Synthesis file path - location of the synthesised spectra pickle file
-synthesis_file: ./run/input/synthesised_spectra.pkl  # Default location
-
-# Reference line for wavelength grid and metadata when combining all spectral lines
-reference_line: Fe12_195.1190  # Default reference line (Fe XII 195.119 Å)
-
-# Point Spread Function
-psf: False  # Enable PSF convolution
-# Or test with and without PSF:
-# psf: [True, False]  # Run simulations both with and without PSF
-
-# Exposure times - can be single value or list
-expos: [0.5 s, 1 s, 2 s, 5 s, 10 s, 20 s, 40 s, 80 s]
-
-# Monte Carlo simulation parameters
-n_iter: 1000      # Number of Monte Carlo iterations
-ncpu: -1        # Number of CPU cores (-1 = use all available)
-
-# Parameter sweeps - you can specify single values or lists for any parameter
-# The simulation will run all combinations of parameters
-
-# Slit width
-slit_width: 0.2 arcsec  # Narrowest slit on EUVST
-
-# Filter parameters (SWC only)
-# Thickness of aluminum oxide layer on entrance filter
-oxide_thickness: 95 angstrom  # Default (expected value)
-
-# Carbon contamination thickness on filter
-c_thickness: 0 angstrom  # Default (ideal case, no contamination)
-
-# Aluminum filter thickness
-aluminium_thickness: 1485 angstrom  # Default (expected value)
+# Input
+instrument: SWC
+synthesis_file: ./run/input/synthesised_spectra.pkl
+reference_line: Fe12_195.1190
+
+# Global settings (apply to all combinations)
+n_iter: 500
+ncpu: -1
+
+# Simulation parameters
+# Any field listed as a list is swept over; all combinations are run.
+simulation:
+  slit_width: [0.2 arcsec, 0.4 arcsec]  # sweep over two slit widths
+  expos: [5 s, 10 s, 20 s, 40 s, 80 s]  # sweep over five exposure times
+  psf: True
+  vis_sl: 0 photon / (s * cm^2)
+  enable_pinholes: False
+
+# Detector parameters
+detector:
+  ccd_temperature: -60 Celsius  # used to compute dark current via the CCD model
+
+# Telescope parameters
+telescope:
+  microroughness_sigma: 0.3 nm  # RMS surface roughness
+
+# Aluminium filter parameters (SWC only)
+filter:
+  al_thickness: 1485 angstrom
+  oxide_thickness: 95 angstrom
+  c_thickness: 40 angstrom
+  mesh_throughput: 0.8
+```
 
-# CCD temperature for dark current calculation
-ccd_temperature: -60 Celsius  # Default (expected operating temperature)
+Any parameter from the `Detector_SWC`, `Telescope_EUVST`, or `AluminiumFilter`
+dataclasses in `config.py` can be added to the corresponding section. For
+example, to sweep over detector quantum efficiency:
 
-# Visible stray light level
-vis_sl: 0 photon / (s * pixel)  # Default, (ideal case, no stray light)
+```yaml
+detector:
+  ccd_temperature: -60 Celsius
+  qe_euv: [0.5, 0.65, 0.76]   # sweep over three QE values
 ```
 
 For guidance on recommended values, see McKevitt et al. (2025) (in prep.).
@@ -344,6 +359,10 @@ Results are saved as pickle files in the `run/result/` directory with the same b
 - Fitted spectral line parameters (intensity, velocity, width)
 - Statistical analysis of velocity precision vs. exposure time
 - Ground truth comparisons
+- Full config objects (`Detector`, `Telescope`, `Simulation`) for each parameter combination
+- The git commit ID and software version used to produce the results
+
+Use `summary_table(results)` after loading to see all parameter combinations and the run metadata.
 
 ## Acknowledgements
 

{solarc_eclipse-0.6.1 → solarc_eclipse-0.6.2}/euvst_response/__init__.py

@@ -4,7 +4,7 @@ ECLIPSE: Emission Calculation and Line Prediction for SOLAR-C EUVST
 This package provides tools for modeling the performance of the EUV spectrograph EUVST, on SOLAR-C.
 """
 
-__version__ = "0.6.1"
+__version__ = "0.6.2"
 __author__ = "James McKevitt"
 __email__ = "jm2@mssl.ucl.ac.uk"
 
@@ -20,7 +20,7 @@ from .pinhole_diffraction import apply_euv_pinhole_diffraction, airy_disk_patter
 from .fitting import fit_cube_gauss, velocity_from_fit, width_from_fit, analyse
 from .monte_carlo import simulate_once, monte_carlo
 from .main import main
-from .data_processing import load_atmosphere
+from .data_processing import load_atmosphere, create_uniform_intensity_cube
 from .analysis import (
     load_instrument_response_results,
     get_parameter_combinations,
@@ -42,6 +42,7 @@ __all__ = [
     "simulate_once", "monte_carlo",
     "main",
     "load_atmosphere",
+    "create_uniform_intensity_cube",
     "load_instrument_response_results",
     "get_parameter_combinations",
     "analyse_fit_statistics",