@@ -78,7 +78,7 @@ def forward(self,
7878 oxygen_correction_factor : float = ATM_DEFAULT_OXYGEN_CORRECTION_FACTOR ,
7979 timescale_auroral : int = ATM_DEFAULT_TIMESCALE_AURORAL ,
8080 timescale_transport : int = ATM_DEFAULT_TIMESCALE_TRANSPORT ,
81- atm_model_version : Literal ["1.0" , " 2.0"= ATM_DEFAULT_MODEL_VERSION ,
81+ atm_model_version : Literal ["2.0" ] = ATM_DEFAULT_MODEL_VERSION ,
8282 custom_spectrum : Optional [ndarray ] = None ,
8383 custom_neutral_profile : Optional [ndarray ] = None ,
8484 no_cache : bool = False ,
@@ -96,9 +96,8 @@ def forward(self,
9696 square input (with time duration T0 and spatial width L) input of precipitation. The initial/boundary
9797 conditions are given by IRI. The output yields the mean density/VER over [0-L] at time T0.
9898
99- Please note that some of the inputs and outputs are only supported by ATM version 2.0. The following
100- inputs are only supported by version 2.0: `kappa_*`, `exponential_*`, `proton_*`, `d_region`, and
101- `custom_neutral_profile`. The following outputs are only supported by version 2.0: `production_rate_*`.
99+ **NOTE**: As of PyUCalgarySRS version 1.26.0, support for model version '1.0' was removed. To
100+ use this version of the model, please use a prior release of PyUCalgarySRS.
102101
103102 **NOTE**: All spectral shapes are super-imposable except exponential (maxwellian, gaussian, kappa). The
104103 exponential spectrum should be only be used for high-energy tail and, starting from E0 (proton_starting_energy),
@@ -218,11 +217,8 @@ def forward(self,
218217 speed. Represented in seconds. Default is 600 (10 minutes). This parameter is optional.
219218
220219 atm_model_version (str):
221- ATM model version number. Possible values are presently "1.0" or " 2.0". The default is "2.0".
220+ ATM model version number. The default is " 2.0". This parameter is optional.
222221
223- **IMPORTANT**: Please note that certain inputs and outputs are only available in version "2.0". See above for
224- more details. This parameter is optional.
225-
226222 no_cache (bool):
227223 The UCalgary Space Remote Sensing API utilizes a caching layer for performing ATM
228224 calculations. If this variation of input parameters has been run before (and the
@@ -242,6 +238,11 @@ def forward(self,
242238 Raises:
243239 pyucalgarysrs.exceptions.SRSAPIError: An API error was encountered
244240 """
241+ if (atm_model_version == "1.0" ):
242+ show_warning ("Using ATM version 1.0 is no longer supported in this library. To use it, please interact " +
243+ "with the API directly (more information at https://api.phys.ucalgary.ca). Defaulting to using version 2.0." )
244+ atm_model_version = 2.0
245+
245246 return func_forward (
246247 self .__srs_obj ,
247248 timestamp ,
@@ -284,18 +285,17 @@ def inverse(self,
284285 output : ATMInverseOutputFlags ,
285286 precipitation_flux_spectral_type : Literal ["gaussian" , "maxwellian" ] = ATM_DEFAULT_PRECIPITATION_SPECTRAL_FLUX_TYPE ,
286287 nrlmsis_model_version : Literal ["00" , "2.0" ] = ATM_DEFAULT_NRLMSIS_MODEL_VERSION ,
287- atmospheric_attenuation_correction : bool = False ,
288288 special_logic_keyword : str = ATM_DEFAULT_SPECIAL_LOGIC_KEYWORD ,
289- atm_model_version : Literal ["1.0" , " 2.0"= ATM_DEFAULT_MODEL_VERSION ,
289+ atm_model_version : Literal ["2.0" ] = ATM_DEFAULT_MODEL_VERSION ,
290290 no_cache : bool = False ,
291291 timeout : Optional [int ] = None ) -> ATMInverseResult :
292292 """
293293 Perform an inverse calculation using the TREx Auroral Transport Model and the supplied input
294294 parameters. Note that this function utilizes the UCalgary Space Remote Sensing API to perform
295295 the calculation.
296296
297- **NOTE**: The 'atmospheric_attenuation_correction' parameter from ATM model version 1.0 was deprecated
298- in v1.23.0. Please ensure you perform this conversion yourself on the results, if desired .
297+ **NOTE**: As of PyUCalgarySRS version 1.26.0, support for model version ' 1.0' was removed. To
298+ use this version of the model, please use a prior release of PyUCalgarySRS .
299299
300300 **NOTE**: As of PyUCalgarySRS version 1.24.0, the `characteristic_energy` output flag was deprecated.
301301 Please use `mean_energy` instead.
@@ -346,18 +346,12 @@ def inverse(self,
346346 optional. More details about this empirical model can be found [here](https://ccmc.gsfc.nasa.gov/models/NRLMSIS~00/),
347347 and [here](https://ccmc.gsfc.nasa.gov/models/NRLMSIS~2.0/).
348348
349- atmospheric_attenuation_correction (bool):
350- Apply an atmospheric attenuation correction factor. Default is `False`.
351-
352- This parameter was deprecated in v1.23.0, and will be removed in a future release.
353-
354349 special_logic_keyword (str):
355350 Use a special keyword provided by UCalgary staff to apply alternative logic during an ATM inversion
356351 request. This parameter is optional.
357352
358353 atm_model_version (str):
359- ATM model version number. Possible values are only '1.0' at this time, but will have
360- additional possible values in the future. This parameter is optional.
354+ ATM model version number. The default is "2.0". This parameter is optional.
361355
362356 no_cache (bool):
363357 The UCalgary Space Remote Sensing API utilizes a caching layer for performing ATM
@@ -378,9 +372,10 @@ def inverse(self,
378372 Raises:
379373 pyucalgarysrs.exceptions.SRSAPIError: An API error was encountered
380374 """
381- if (atmospheric_attenuation_correction is True ):
382- show_warning ("The atmospheric_attenuation_correction parameter was deprecated in v1.23.0. If you want this correction, " +
383- "please perform it yourself on the result." )
375+ if (atm_model_version == "1.0" ):
376+ show_warning ("Using ATM version 1.0 is no longer supported in this library. To use it, please interact " +
377+ "with the API directly (more information at https://api.phys.ucalgary.ca). Defaulting to using version 2.0." )
378+ atm_model_version = 2.0
384379
385380 return func_inverse (
386381 self .__srs_obj ,
0 commit comments