ronswanson.utils package

Submodules

ronswanson.utils.cartesian_product module

ronswanson.utils.cartesian_product.cartesian_jit(arrays)[source]

ronswanson.utils.check_complete module

ronswanson.utils.check_complete.check_complete_ids(database_file_name: str) List[int][source]
ronswanson.utils.check_complete.int_formatter(val, chars, delta, left)[source]
ronswanson.utils.check_complete.make_fig(this_name: str, other_name: str, finished_values: ndarray, unfinished_values: ndarray, width: int) str[source]
ronswanson.utils.check_complete.examine_parameter(database_file_name: str, parameter_grid_file_name: str, parameter_to_check: str) None[source]
ronswanson.utils.check_complete.make_fig_detailed(this_name: str, other_name: str, this_param_values: ndarray, other_param_values: ndarray, count_dict: Dict[str, Dict[str, int]], n_points: int, width: int, colormap) None[source]
ronswanson.utils.check_complete.examine_parameter_detailed(database_file_name: str, parameter_grid_file_name: str, parameter_to_check: str, colormap: Optional[str] = None) None[source]

ronswanson.utils.color module

class ronswanson.utils.color.Colors(value)[source]

Bases: Enum

An enumeration.

RED = '#FC0A5A'
BLUE = '#1B71FD'
GREEN = '#1BFDA7'
YELLOW = '#ECD518'

ronswanson.utils.colormap_generator module

ronswanson.utils.colormap_generator.hex_to_rgb(value)[source]

Converts hex to rgb colours value: string of 6 characters representing a hex colour. Returns: list length 3 of RGB values

ronswanson.utils.colormap_generator.rgb_to_dec(value)[source]

Converts rgb to decimal colours (i.e. divides each value by 256) value: list (length 3) of RGB values Returns: list (length 3) of decimal values

ronswanson.utils.colormap_generator.get_continuous_cmap(hex_list, float_list=None)[source]

ronswanson.utils.configuration module

class ronswanson.utils.configuration.Logging(on: bool = True, level: str = 'WARNING')[source]

Bases: object

on: bool = True
level: str = 'WARNING'
__init__(on: bool = True, level: str = 'WARNING') None
class ronswanson.utils.configuration.SLURM(user_email: str = 'user@email.com', modules: Union[List[str], NoneType] = None, mpi_modules: Union[List[str], NoneType] = None, python: str = 'python', store_dir: Union[str, NoneType] = None)[source]

Bases: object

user_email: str = 'user@email.com'
modules: Optional[List[str]] = None
mpi_modules: Optional[List[str]] = None
python: str = 'python'
store_dir: Optional[str] = None
__init__(user_email: str = 'user@email.com', modules: Optional[List[str]] = None, mpi_modules: Optional[List[str]] = None, python: str = 'python', store_dir: Optional[str] = None) None
class ronswanson.utils.configuration.RonSwansonConfig(logging: ronswanson.utils.configuration.Logging = Logging(on=True, level='WARNING'), slurm: ronswanson.utils.configuration.SLURM = SLURM(user_email='user@email.com', modules=None, mpi_modules=None, python='python', store_dir=None))[source]

Bases: object

logging: Logging = Logging(on=True, level='WARNING')
slurm: SLURM = SLURM(user_email='user@email.com', modules=None, mpi_modules=None, python='python', store_dir=None)
__init__(logging: Logging = Logging(on=True, level='WARNING'), slurm: SLURM = SLURM(user_email='user@email.com', modules=None, mpi_modules=None, python='python', store_dir=None)) None
ronswanson.utils.configuration.recurse_dict(d, tree) None[source]
ronswanson.utils.configuration.show_configuration() Tree[source]

ronswanson.utils.file_open module

ronswanson.utils.file_open.open_component_file(database_file_name: str, sim_id: int) File[source]

ronswanson.utils.hdf5_utils module

ronswanson.utils.logging module

class ronswanson.utils.logging.LogFilter(level)[source]

Bases: object

__init__(level)[source]
filter(logRecord)[source]
ronswanson.utils.logging.silence_warnings()[source]

supress warning messages in console and file usr logs

ronswanson.utils.logging.activate_warnings()[source]

supress warning messages in console and file usr logs

ronswanson.utils.logging.update_logging_level(level)[source]
ronswanson.utils.logging.setup_logger(name)[source]

ronswanson.utils.package_data module

ronswanson.utils.package_data.get_path_of_data_file(data_file: str) Path[source]

get the path of a dat file

Parameters:

data_file (str) – name of the data file

Returns:

ronswanson.utils.package_data.get_path_of_data_dir() Path[source]

get the path of the package data directory

Returns:

ronswanson.utils.quailty_checks module

ronswanson.utils.quailty_checks.first_last_nonzero(arr, axis, invalid_val=-1)[source]
ronswanson.utils.quailty_checks.check_for_non_contiguous_spectra(database: Database) ndarray[source]

find spectra with non-contiguous values (go to zero in between)

Parameters:

database (Database) –

Returns:

Module contents