SAPPHIRE Peak Flux
Model API name: sapphire-peak-flux
The Solar Accumulated and Peak Proton and Heavy Ion Radiation Environment (SAPPHIRE) model covers all SEP environment timescales across all relevant species in a consistent probabilistic manner.
Version: v1
Model developer:
Model provision:
Model references:
External Input: trajectory
| Input | Value |
|---|---|
| Model name |
sapre
sapre_upload
|
trajectory
|
| Model result name | trajectory |
| Quantity | trajectory |
Input group: sepflare / multiplicity: one
| Input | Description | Valid values | Default | Quantity |
|---|---|---|---|---|
| lowestIonSpecies | Atomic number of lightest ion. |
min: 1 max: 92 note: Must be less than highestIonSpecies |
1 | atomic_number |
| highestIonSpecies | Atomic number of heaviest ion. |
min: 1 max: 92 note: Must be greater than lowestIonSpecies |
92 | atomic_number |
| predictionPeriodFlag |
Prediction period flag.
0: Automatic, 1: manual entry |
|
0 | number |
| solarCycleOffset |
Offset in solar cycle.
Automatic: 0, manual entry: 1 |
|
0 | number |
| confidenceLevel |
Confidence level
The probability (in %) that the predicted proton fluences will not be exceeded |
min: 10 max: 95 |
95.0 | number |
| dataSet | Dataset to use |
sapphire=SAPPHIRE sapphire-hex=SAPPHIRE-HEX |
sapphire | number |
| distanceFromSun | Distance from the Sun (AU). |
min: 0 max: unbounded |
1.0 | number |
geomagnetic shielding
| Input | Description | Valid values | Default | Quantity |
|---|---|---|---|---|
| useGeomagneticShielding | Include geomagnetic shielding |
0=No 1=Yes |
0 | number |
| arrivalDirection |
Specify arrival direction (only when using geomagnetic shielding).
Used if useGeomagneticShielding == 1 |
0=All directions 1=Vertical only |
0 | number |
| magnetosphereState |
State of the magnetosphere (only when using geomagnetic shielding).
Used if useGeomagneticShielding == 1 |
0=Quiet 1=Stormy |
0 | number |
| method |
Method (only when using geomagnetic shielding).
Used if useGeomagneticShielding == 1 |
0=Stormer with eccentric dipole 1=Smart and Shea (1967) with IGRF 2=Stormer upgrade |
0 | number |
| magneticFieldMoment |
Magnetic field moment.
Only when using geomagnetic shielding. Used if useGeomagneticShielding == 1 |
0=McIlwain 1=Unchanged -1=CREME-86 -2=CREME-96 |
1 | number |
|
None
# coding=utf-8
import numpy as np
import matplotlib.pyplot as plt
from nom_client.nom_client import NoMClient
model_params = {
'creme-96-sep': "differential_flux",
'sapphire-peak-flux': "differential_flux",
'sapphire-total-fluence': "differential_fluence"
}
model_to_use = 'sapphire-peak-flux'
#model_to_use = 'sapphire-total-fluence'
model_to_use = 'creme-96-sep'
nom_client = NoMClient("SAPPHIRE Peak flux example", default_server_id="local_server")
trajectory_model = nom_client.get_model('trajectory')
trajectory_model.set_params(orbitSpecificationCode=205, naifCode=10, duration=10)
# trajectory_model.set_params(orbitSpecificationCode="NEI")
trajectory_result = nom_client.run_model(trajectory_model)
print(trajectory_result)
# Get the model specification from the server.
# sapphire_model = nom_client.get_model('sapphire-peak-flux')
sapphire_model = nom_client.get_model(model_to_use)
sapphire_model.set_external_input(external_input_name="trajectory", external_input=trajectory_result)
# Geomagnetic shielding
sapphire_results_no_geo_sheilding = nom_client.run_model(sapphire_model)
sep_proton_spectrum_no_geo_sheilding = sapphire_results_no_geo_sheilding.get_model_result_by_name(
result_name="sep_proton_spectrum")
differential_fluence_no_geo_sheilding = sep_proton_spectrum_no_geo_sheilding.get_variable_data(
variable_name=model_params[model_to_use])
energy = sep_proton_spectrum_no_geo_sheilding.get_variable_data(variable_name="energy")[
0] # same energies with or without geo shielding
energy = np.array(energy)
fig, ax = plt.subplots()
flux_units = sep_proton_spectrum_no_geo_sheilding[model_params[model_to_use]].units
for fl_data in [differential_fluence_no_geo_sheilding]:
plt.loglog(energy, fl_data.T, '-', linewidth=2.0, markersize=12.0)
plt.rc('font', size=12)
plt.grid(True)
plt.legend(labels=["No shielding (default)"])
plt.xlabel("Energy")
plt.ylabel(f"Flux ({flux_units})")
plt.show()