Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove deprecated arguments from SN model initialisers #356

Merged
merged 6 commits into from
Aug 15, 2024
Merged

Remove deprecated arguments from SN model initialisers #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5e3eb1f
remove legacy_filename_initialization from SN models
JostMigenda Aug 13, 2024
32c1ed3
remove deprecated arguments in OConnor_2013 model
JostMigenda Aug 13, 2024
742d370
Delete _metadata_from_filename functions
JostMigenda Aug 13, 2024
19c3eaa
Remove deprecated SN model initialisation arguments
JostMigenda Aug 14, 2024
1adafe4
update docstring after removing _legacy_filename_initialization
JostMigenda Aug 14, 2024
be9a459
Fix snowglobes.py (still uses filename initialisation under the hood)
JostMigenda Aug 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 7 additions & 110 deletions python/snewpy/models/ccsn.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
The submodule ``snewpy.models.ccsn`` contains models of core-collapse supernovae
derived from the :class:`SupernovaModel` base class.

Since SNEWPY v1.3, the prefered method is to initialise a model based on its physics parameters.
Initialisation from a file name is deprecated.

Models are initialised based on their physics parameters.
Use the ``param`` class property to view all physics parameters and their possible values:

>>> from snewpy.models.ccsn import Nakazato_2013
Expand Down Expand Up @@ -40,11 +38,9 @@ class method to get a list of all valid combinations and filter it:
from .base import PinchedModel

from snewpy.models.registry_model import RegistryModel, Parameter
from snewpy.models.registry_model import deprecated, legacy_filename_initialization
from snewpy.models.registry_model import all_models
from textwrap import dedent

@legacy_filename_initialization
@RegistryModel(
progenitor_mass = [13, 20, 30, 50] * u.Msun,
revival_time = [0, 100, 200, 300] * u.ms,
Expand All @@ -61,23 +57,6 @@ class Nakazato_2013(loaders.Nakazato_2013):
(2013), ApJ 804:75 (2015), PASJ 73:639 (2021). See also http://asphwww.ph.noda.tus.ac.jp/snn/.
"""

def _metadata_from_filename(self, filename:str)->dict:
metadata = {'Progenitor mass': float(filename.split('-')[-1].strip('s%.fits')) * u.Msun}
if 't_rev' in filename:
metadata.update({
'EOS': filename.split('-')[-4].upper(),
'Metallicity': float(filename.split('-')[-3].strip('z%')),
'Revival time': float(filename.split('-')[-2].strip('t_rev%ms')) * u.ms
})
# No revival time because the explosion "failed" (BH formation).
else:
metadata.update({
'EOS': filename.split('-')[-4].upper(),
'Metallicity': float(filename.split('-')[-2].strip('z%')),
'Revival time': 0 * u.ms
})
return metadata

def __init__(self, progenitor_mass:u.Quantity, revival_time:u.Quantity, metallicity:float, eos:str):
# Strip units for filename construction
progenitor_mass = progenitor_mass.to(u.Msun).value
Expand All @@ -92,21 +71,13 @@ def __init__(self, progenitor_mass:u.Quantity, revival_time:u.Quantity, metallic
return super().__init__(filename, self.metadata)


@legacy_filename_initialization
@RegistryModel(
progenitor_mass = [27., 9.6] * u.Msun,
eos = ['LS220', 'SFHo']
)
class Sukhbold_2015(loaders.Sukhbold_2015):
"""Model based on simulations from Sukhbold et al., ApJ 821:38,2016. Models were shared privately by email.
"""
def _metadata_from_filename(self, filename:str):
metadata = {
'Progenitor mass': float(filename.split('-')[-1].strip('z%.fits')) * u.Msun,
'EOS': filename.split('-')[-2]
}
return metadata

def __init__(self, progenitor_mass:u.Quantity, eos:str):
if progenitor_mass.value == 9.6:
filename = f'sukhbold-{eos}-z{progenitor_mass.value:3.1f}.fits'
Expand All @@ -115,7 +86,6 @@ def __init__(self, progenitor_mass:u.Quantity, eos:str):
return super().__init__(filename, self.metadata)


@legacy_filename_initialization
@RegistryModel(
progenitor_mass = [11.2, 20., 27.] * u.Msun,
direction = [1,2,3],
Expand All @@ -133,7 +103,6 @@ def __init__(self, *, progenitor_mass:u.Quantity, direction:int):
# Metadata is handled by __init__ in _GarchingArchiveModel
return super().__init__(filename=filename, metadata=self.metadata)

@legacy_filename_initialization
@RegistryModel(
progenitor_mass= [11.2, 27.] * u.Msun,
eos = ['LS220']
Expand All @@ -146,7 +115,6 @@ def __init__(self, progenitor_mass:u.Quantity, eos:str='LS220'):
filename = f's{progenitor_mass.value:3.1f}c'
return super().__init__(filename=filename, metadata=self.metadata)

@legacy_filename_initialization
@RegistryModel(
progenitor_mass = [15.] * u.Msun,
rotation = ['fast','slow','non'],
Expand All @@ -164,7 +132,6 @@ def __init__(self, *, progenitor_mass:u.Quantity, rotation:str, direction:int):
return super().__init__(filename=filename, metadata=self.metadata)


@legacy_filename_initialization
@RegistryModel(
progenitor_mass = [40., 75.] * u.Msun,
direction = [1,2,3],
Expand All @@ -190,77 +157,39 @@ def __init__(self, * ,progenitor_mass:u.Quantity, direction:int):
),
eos = ['HShen', 'LS220']
)
class _OConnor_2013_new(loaders.OConnor_2013):
class OConnor_2013(loaders.OConnor_2013):
"""Model based on the black hole formation simulation in `O'Connor & Ott (2013) <https://arxiv.org/abs/1207.1100>`_.
"""
def __init__(self, eos:str, progenitor_mass:u.Quantity):
# Load from Parameters
filename = f'{eos}_timeseries.tar.gz'
return super().__init__(filename=filename, metadata=self.metadata)

class OConnor_2013(legacy_filename_initialization(_OConnor_2013_new)):
_config_path='ccsn.OConnor_2013'

@deprecated('base', 'mass')
def __init__(self, base=None, mass=None, eos='LS220', *, progenitor_mass=None):
"""
Parameters
----------
base : str
Absolute or relative path folder with model data. This argument is deprecated.
mass: int
Mass of model progenitor in units Msun. This argument is deprecated.
"""
if mass:
progenitor_mass = mass*u.Msun
if base:
self.metadata = {'Progenitor mass': progenitor_mass,
'EOS': eos}
filename = f'{base}/{eos}_timeseries.tar.gz'
return super().__init__(filename=filename, eos=eos, progenitor_mass=progenitor_mass)
else:
return super().__init__(eos=eos, progenitor_mass=progenitor_mass)

OConnor_2013.__init__.__doc__=dedent(OConnor_2013.__init__.__doc__)+_OConnor_2013_new.__init__.__doc__
#make sure that only the latest class is present in the models table
all_models.remove(OConnor_2013.__mro__[1])
all_models.add(OConnor_2013)

@deprecated('eos')
@legacy_filename_initialization
@RegistryModel(
progenitor_mass = [40 * u.Msun],
eos=['LS220']
)
class OConnor_2015(loaders.OConnor_2015):
"""Model based on the black hole formation simulation in `O'Connor (2015) <https://arxiv.org/abs/1411.7058>`_.
"""
def __init__(self, progenitor_mass:u.Quantity):
self.metadata["EOS"] = "LS220"
# Filename is currently the same regardless of parameters
filename = 'M1_neutrinos.dat'
return super().__init__(filename, self.metadata)

@deprecated('eos')
@legacy_filename_initialization
@RegistryModel(
progenitor_mass = Parameter(values=(list(range(16, 27)) + [19.89, 22.39, 30, 33]) * u.Msun,
desc_values = '[16..26, 19.89, 22.39, 30, 33] solMass'
),
eos = ['STOS_B145']
)
class Zha_2021(loaders.Zha_2021):
"""Model based on the hadron-quark phse transition models from `Zha et al. 2021 <https://arxiv.org/abs/2103.02268>`_.
"""
def _metadata_from_filename(self, filename:str)->dict:
metadata = {'Progenitor mass': float(os.path.splitext(os.path.basename(filename))[0][1:]) * u.Msun}
return metadata

def __init__(self, *, progenitor_mass:u.Quantity):
self.metadata["EOS"] = "STOS_B145"
filename = f's{progenitor_mass.value:g}.dat'
return super().__init__(filename, self.metadata)

@deprecated('eos')
@legacy_filename_initialization
@RegistryModel(
progenitor_mass=Parameter(np.concatenate((np.linspace(9.0, 12.75, 16),
np.linspace(13, 30., 171),
Expand All @@ -274,21 +203,14 @@ def __init__(self, *, progenitor_mass:u.Quantity):
label='Turb. mixing param.',
description='Turbulent mixing parameter alpha_lambda',
),
eos=['SFHo']
)
class Warren_2020(loaders.Warren_2020):
"""Model based on simulations from Warren et al., ApJ 898:139, 2020.
Neutrino fluxes available at https://doi.org/10.5281/zenodo.3667908."""
# np.arange with decimal increments can produce floating point errors
# Though it may be more intuitive to use np.arange, these fp-errors quickly become troublesome
def _metadata_from_filename(self, filename:str)->dict:
_, _, turbmixing_param, progenitor_mass = os.path.splitext(os.path.basename(filename))[0].split('_')
metadata = {'Progenitor mass': float(progenitor_mass[1:]) * u.Msun,
'Turb. mixing param.': float(turbmixing_param[1:]),
'EOS': 'SFHo'}
return metadata

def __init__(self, *, progenitor_mass, turbmixing_param):
self.metadata["EOS"] = "SFHo"
if progenitor_mass.value.is_integer() and progenitor_mass.value <= 30.:
fname = os.path.join(f'stir_a{turbmixing_param:3.2f}',
f'stir_multimessenger_a{turbmixing_param:3.2f}_m{progenitor_mass.value:.1f}.h5')
Expand All @@ -297,48 +219,29 @@ def __init__(self, *, progenitor_mass, turbmixing_param):
f'stir_multimessenger_a{turbmixing_param:3.2f}_m{progenitor_mass.value:g}.h5')
return super().__init__(fname, self.metadata)

@deprecated('eos','mass')
@legacy_filename_initialization
@RegistryModel(
rotational_velocity= [0, 1] * u.rad / u.s,
magnetic_field_exponent= Parameter([0, 12, 13],
label='B_0 Exponent',
description='Exponent of magnetic field (See Eq. 46)'),
eos=['LS220'],
progenitor_mass=[20*u.Msun],
_param_validator = lambda p: (p['rotational_velocity'].value == 1 and p['magnetic_field_exponent'] in (12, 13)) or \
(p['rotational_velocity'].value == 0 and p['magnetic_field_exponent'] == 0)
)
class Kuroda_2020(loaders.Kuroda_2020):
"""Model based on simulations from `Kuroda et al. (2020) <https://arxiv.org/abs/2009.07733>`_."""

def _metadata_from_filename(self, filename:str)->dict:
_, rotational_velocity, magnetic_field_exponent = re.split('R|B', os.path.splitext(os.path.basename(filename))[0])
metadata = {
'Progenitor mass': 20 * u.Msun,
'Rotational Velocity': int(rotational_velocity[0]),
'B_0 Exponent': int(magnetic_field_exponent),
'EOS': 'LS220'
}
return metadata

def __init__(self, mass=None, *, rotational_velocity, magnetic_field_exponent):
def __init__(self, *, rotational_velocity, magnetic_field_exponent):
self.metadata["EOS"] = "LS220"
filename = f'LnuR{int(rotational_velocity.value):1d}0B{int(magnetic_field_exponent):02d}.dat'
return super().__init__(filename, self.metadata)

@legacy_filename_initialization
@RegistryModel(
progenitor_mass=[9, 10, 12, 13, 14, 15, 16, 19, 25, 60] * u.Msun,
)
class Fornax_2019(loaders.Fornax_2019):
"""Model based on 3D simulations from D. Vartanyan, A. Burrows, D. Radice, M. A. Skinner and J. Dolence, MNRAS 482(1):351, 2019.
Data available at https://www.astro.princeton.edu/~burrows/nu-emissions.3d/
"""
def _metadata_from_filename(self, filename:str)->dict:
progenitor_mass = os.path.splitext(os.path.basename(filename))[0].split('_')[2]
metadata = {'Progenitor mass': int(progenitor_mass[:-1]) * u.Msun}
return metadata

def __init__(self, cache_flux=False, *, progenitor_mass):
"""
Parameters
Expand All @@ -352,7 +255,6 @@ def __init__(self, cache_flux=False, *, progenitor_mass):
filename = f'lum_spec_{int(progenitor_mass.value):d}M.h5'
return super().__init__(filename, self.metadata, cache_flux=cache_flux)

@legacy_filename_initialization
@RegistryModel(
progenitor_mass = Parameter((list(range(12, 24)) + [25, 26, 26.99]) * u.Msun,
desc_values='[12..23, 25, 26, 26.99] solMass')
Expand All @@ -361,11 +263,6 @@ class Fornax_2021(loaders.Fornax_2021):
"""Model based on 3D simulations from D. Vartanyan, A. Burrows, D. Radice, M. A. Skinner and J. Dolence, MNRAS 482(1):351, 2019.
Data available at https://www.astro.princeton.edu/~burrows/nu-emissions.3d/
"""
def _metadata_from_filename(self, filename:str)->dict:
progenitor_mass = os.path.splitext(os.path.basename(filename))[0].split('_')[2]
metadata = {'Progenitor mass': float(progenitor_mass[:-1]) * u.Msun}
return metadata

def __init__(self, progenitor_mass:u.Quantity):
# Load from Parameters
if progenitor_mass.value.is_integer():
Expand Down
84 changes: 0 additions & 84 deletions python/snewpy/models/registry_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
from functools import wraps
import itertools as it
import inspect
import os
from textwrap import dedent
from warnings import warn
import numpy as np
Expand Down Expand Up @@ -65,41 +64,6 @@ def _wrapper(obj):
else:
return func_decorator(obj)
return _wrapper

def deprecated(*names, message='Argument `{name}` is deprecated.'):
"""A function decorator to issue a deprecation warning if a given argument is provided in the wrapped function call.

Parameters
----------

names: list of str
argument names which are deprecated
message: str
a template with {name} parameter, to make the message for each argument.

.. Example::

@deprecated('foo','bar', message='Argument `{name}` is deprecated and will be removed in SNEWPYv2.0!')
def test_function(*, foo=1, bar=2, baz=3):
pass

#calling test_function(foo=1, baz=3) will issue a deprecation warning:
# DeprecationWarning: Argument `foo` is deprecated and will be removed in SNEWPYv2.0!
"""
@_can_decorate_class_or_func
def _wrapper(func):
#get function signature
S = inspect.signature(func)
@wraps(func)
def _f(*args, **kwargs):
#bind signature to find all the parameters
params = S.bind(*args,**kwargs)
for name in names:
if name in params.arguments:
warn(message.format(name=name), category=UserWarning, stacklevel=2)
return func(*args,**kwargs)
return _f
return _wrapper

def map_arguments(**names_dict):
"""map function arguments to create a function with new signature,
Expand Down Expand Up @@ -378,7 +342,6 @@ def RegistryModel(_param_validator=None, **params):
* Validation of the input user parameters (see :meth:`RegistryModel.validate`)
* Generated constructor docstring based on allowed parameters
* Populates the `self.metadata` from the given user parameters
* Optional (deprecated) "filename" argument, and calls initialization from the filename

The decorated class:
* *must* inherit from the loader class
Expand All @@ -387,10 +350,8 @@ def RegistryModel(_param_validator=None, **params):
1. defines the filename from the given user parameters
2. optionally modify the `self.metadata` dictionary, and
3. calls the corresponding loader class constructor
* *can* define the ``_metadata_from_filename (self, filename:str)->dict``, to help populate the metadata when a `filename` argument is passed

If a parameter has a single allowed value (i.e. fixed), this value will be default for this parameter in constructor.

"""
pset:ParameterSet = ParameterSet(param_validator=_param_validator, **params)
def _wrap(base_class):
Expand Down Expand Up @@ -460,48 +421,3 @@ def get_param_combinations(cls)->tuple:
all_models.add(c)
return c
return _wrap

def legacy_filename_initialization(c):
"""Wrap the model class, adding a filename argument in the init"""

@deprecated('filename')
class c1(c):
_loader_class = c.__mro__[2] #store the loader class for later use

def __init__(self, filename:str=None, *args, **kwargs):
if filename is not None:
if not hasattr(self,'metadata'):
self.metadata = {}
if hasattr(self,'_metadata_from_filename'):
self.metadata.update(self._metadata_from_filename(filename))
self._loader_class.__init__(self, filename=os.path.abspath(filename), metadata=self.metadata)
else:
super().__init__(*args, **kwargs)

#generate the docstring
c1.__doc__ = c.__doc__
c1._doc_params_ = {'Parameters':
"""filename: str\n Absolute or relative path to the file with model data. This argument is deprecated.""",
**c._doc_params_}
c1.__init__.__doc__ = c1._generate_docstring()
#update the call signature
S = inspect.signature(c)
S1 = inspect.signature(c1.__init__)
#set default values to None if they are not set
other_params = []
for p in S.parameters.values():
if p.default==p.empty:
p = p.replace(default=None)
other_params+=[p]
params = [S1.parameters['self'],S1.parameters['filename'],*other_params]
#fill the constructor signature
c1.__init__.__signature__ = S.replace(parameters=params)
#fill the class and module name to be the same as in class
c1.__qualname__ = c.__qualname__
c1.__name__ = c.__name__
c1.__module__ = c.__module__
#register the model in the list
global all_models
all_models.remove(c)
all_models.add(c1)
return c1
Loading
Loading