EUVpy.empiricalModels.models.HEUVAC.heuvac module¶
- EUVpy.empiricalModels.models.HEUVAC.heuvac.getFlux(userFile)[source]¶
Read the output file from HEUVAC in the user-defined bins.
- Parameters:
userFile (str) – The filename where the HEUVAC fluxes in the user-defined bins have been output.
- Returns:
wav (numpy.ndarray) – The wavelength bin centers for the user-defined bins (Angstroms).
flux (numpy.ndarray) – The HEUVAC flux in the user-defined bins (ph/cm2/s).
irr (numpy.ndarray) – The HEUVAC irradiance in the user-defined bins (W/m2/nm).
- EUVpy.empiricalModels.models.HEUVAC.heuvac.getTorr(fluxFile)[source]¶
Helper function that reads the output file from HEUVAC in the Torr bins.
- Parameters:
fluxFile (str) – The filename where the HEUVAC fluxes in the Torr bins have been output.
- Returns:
wav (ndarray) – The wavelength bin centers for the Torr bins (Angstroms).
flux (numpy.ndarray) – The HEUVAC flux in the Torr bins (W/m2/nm).
irr (numpy.ndarray) – The HEUVAC irradiance in the Torr bins (W/m2/nm).
- EUVpy.empiricalModels.models.HEUVAC.heuvac.heuvac(F107, F107A, torr=True, statsFiles=None)[source]¶
Main function for executing HEUVAC: Call the HEUVAC Fortran code for each individual F10.7, F10.7A pair. For more details on HEUVAC, please see Richards, et al. 2006 (doi:10.1016/j.asr.2005.06.031).
- Parameters:
F107 (arraylike) – The values of [daily] F10.7.
F107A (arraylike) – The values of 81-day averaged F10.7, centered on the current day.
torr (bool) – Controls whether or not the binned data returned is in the 37 standard Torr et al bins or in the high-resolution 10 Angstrom-wide bins (the standard high resolution of HEUVAC). Default is True.
- Returns:
heuvacWav (numpy.ndarray) – The bin center wavelengths for the HEUVAC data.
heuvacFlux (numpy.ndarray) – The solar EUV flux in different wavelength bins returned from HEUVAC.
heuvacIrr (numpy.ndarray) – The solar EUV irradiance in different wavelength bins returend from HEUVAC.
- EUVpy.empiricalModels.models.HEUVAC.heuvac.writeInputFile(F107, F107A)[source]¶
Helper function that writes the formatted input file that the HEUVAC model uses during execution. This function writes the input file to an internal location, and it does not return anything.
- Parameters:
F107 (float) – A single value of F10.7.
F107A (float) – A single value for the 81-day averaged F10.7, centered on the current day.