Skip to content

CUCX

CustomUnitConverterX

Bases: Utils, Refs

Source code in pycuc/docs/cucx.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
class CustomUnitConverterX(Utils, Refs):

    # pressure
    _pressure_conversions = {}
    # temperature
    _temperature_conversions = {}
    # Initialize empty custom conversions dictionary
    _custom_conversions = {}

    # load conversion unit
    _custom_conversions_full = {
        'CUSTOM': _custom_conversions
    }

    def __init__(self, value, unit, reference_file=None):
        self.value = value
        self.unit = str(unit).strip()
        self.reference_file = reference_file
        # utils init
        Utils().__init__()
        Refs().__init__()

        # init vars
        self._pressure_conversions = self.pressure_conversions_ref
        self._temperature_conversions = self.temperature_conversions_ref

    def check_reference(self, reference, dataframe=True):
        '''
        Checks if the reference is valid

        Parameters
        ----------
        reference : str
            reference name such as pressure, temperature, custom

        Returns
        -------
        reference : dict | dataframe
            reference details
        '''
        try:
            # set
            reference = str(reference).strip().upper()

            # sub reference
            sub_reference = None
            if '::' in reference:
                # split
                reference_split = reference.split('::')
                # set
                reference = reference_split[1]
                sub_reference = reference

            # refs
            refs = {
                'PRESSURE': self._pressure_conversions,
                'TEMPERATURE': self._temperature_conversions,
                'CUSTOM': self._custom_conversions_full
            }

            # take all keys
            custom_keys = list(self._custom_conversions_full.keys())
            # all keys
            all_keys = list(set(list(refs.keys()) + custom_keys))

            # check
            if reference not in all_keys:
                raise Exception('Reference not found')

            # if contain ::
            if sub_reference:
                # set
                res = self._custom_conversions_full[sub_reference]
            else:
                # dict
                res = refs[reference]

            if dataframe:
                # Convert dictionary to DataFrame
                df = pd.DataFrame(
                    list(res.items()),
                    columns=['Unit', 'Value']
                )
                return df
            else:
                return res
        except Exception as e:
            raise Exception(f'Checking {reference} failed!, ', e)

    def find_reference(self, from_unit, to_unit):
        '''
        Finds the conversion function

        Parameters
        ----------
        from_unit : str
            from unit
        to_unit : str
            to unit

        Returns
        -------
        reference : str
            reference name such as pressure, temperature, custom
        '''
        try:
            # reference
            reference = None
            # pressure
            if from_unit in self._pressure_conversions and to_unit in self._pressure_conversions:
                reference = 'PRESSURE'
            # temperature
            elif from_unit in self._temperature_conversions and to_unit in self._temperature_conversions:
                reference = 'TEMPERATURE'
            # custom
            elif from_unit in self._custom_conversions and to_unit in self._custom_conversions:
                reference = 'CUSTOM'
            else:
                # check
                for key, value in self._custom_conversions_full.items():
                    if from_unit in value and to_unit in value:
                        reference = 'CUSTOM'

            # check
            if reference is None:
                raise Exception('Conversion units not found')

            return reference
        except Exception as e:
            raise Exception('Finding reference failed!, ', e)

    def check_conversion_block(self, conversion_block):
        '''
        Checks conversion block

        Parameters
        ----------
        conversion_block : str
            conversion block

        Returns
        -------
        subgroups : list
            list of subgroups. [0] = from_unit, [1] = '=>', [2] = to_unit
        '''
        try:
            return self.parse_conversion_block(conversion_block)
        except Exception as e:
            raise Exception("Checking conversion block failed!, ", e)

    def to(self, value, unit_conversion_block, reference=None):
        '''
        Converts through a unit conversion block

        Parameters
        ----------
        value : float
            value
        unit_conversion_block : str
            unit conversion block
        reference : str
            reference name such as pressure, temperature, custom
        '''
        try:
            # interpret the unit conversion block
            from_unit, _, to_unit = self.check_conversion_block(
                unit_conversion_block)

            # convert
            return self.convert(value, from_unit, to_unit, reference)
        except Exception as e:
            raise Exception('Conversion failed!, ', e)

    def from_to(self, value, from_unit, to_unit, reference=None):
        '''
        Converts from one unit to another

        Parameters
        ----------
        value : float
            value
        from_unit : str
            from unit
        to_unit : str
            to unit
        '''
        try:
            # convert
            return self.convert(value, from_unit, to_unit, reference)
        except Exception as e:
            raise Exception('Conversion failed!, ', e)

    def convert(self, value, from_unit, to_unit, reference=None):
        '''
        Selects the conversion function

        Parameters
        ----------
        value: float
            value
        from_unit : str
            from unit
        to_unit : str
            to unit
        reference : str
            reference name such as PRESSURE, TEMPERATURE, CUSTOM
        '''
        try:
            # find reference
            if reference is None:
                reference = self.find_reference(from_unit, to_unit)

            # upper
            reference = reference.upper()

            # reference
            ref = {
                'PRESSURE': self._pressure_conversions,
                'TEMPERATURE': self._temperature_conversions,
                'CUSTOM': self._custom_conversions
            }

            # check
            if reference not in ref.keys():
                raise Exception('Reference not found')

            # reference
            ref_methods = {
                'PRESSURE': lambda x, y, z: self.convert_pressure(x, y, z),
                'TEMPERATURE': lambda x, y, z: self.convert_temperature(x, y, z),
                'CUSTOM': lambda x, y, z: self.convert_custom(x, y, z)
            }

            # check
            if reference not in ref_methods:
                raise Exception('Reference not found')

            # set
            res = ref_methods[reference](value, from_unit, to_unit)

            return res
        except Exception as e:
            raise Exception('Setting conversion function failed!, ', e)

    def convert_pressure(self, value, from_unit, to_unit):
        '''
        Converts pressure from one unit to another.

        Parameters
        ----------
        value : float
            value
        from_unit : str
            from unit
        to_unit : str
            to unit

        Returns
        -------
        float
            converted value
        '''
        try:
            # res
            return float(value) / float(self._pressure_conversions[from_unit]) * float(self._pressure_conversions[to_unit])
        except Exception as e:
            raise Exception('Pressure conversion failed!, ', e)

    def convert_temperature(self, value, from_unit, to_unit):
        '''
        Converts temperature from one unit to another.

        Parameters
        ----------
        value : float
            value
        from_unit : str
            from unit
        to_unit : str
            to unit

        Returns
        -------
        float
            converted value
        '''
        try:
            # set
            value = float(value)

            # Convert to Celsius first
            if from_unit == 'F':
                value = (
                    value - self._temperature_conversions[from_unit]) * 5/9
            elif from_unit == 'K':
                value = value + self._temperature_conversions[from_unit]
            elif from_unit == 'R':
                value = (
                    value - self._temperature_conversions[from_unit]) * 5/9

            # Convert from Celsius to target unit
            if to_unit == 'F':
                result = value * 9/5 + self._temperature_conversions[to_unit]
            elif to_unit == 'K':
                result = value - self._temperature_conversions[to_unit]
            elif to_unit == 'R':
                result = value * 9/5 + self._temperature_conversions[to_unit]
            else:  # to_unit == 'C'
                result = value

            return result
        except Exception as e:
            raise Exception('Temperature conversion failed!, ', e)

    def add_custom_unit(self, unit, conversion_factor):
        '''
        Adds a custom unit conversion to the reference dictionary

        Parameters
        ----------
        unit : str
            unit
        conversion_factor : float
            conversion factor

        Returns
        -------
        bool
            True if successful
        '''
        try:
            # add
            self._custom_conversions[unit] = conversion_factor
            return True
        except Exception as e:
            raise Exception('Adding new unit failed!, ', e)

    def load_custom_unit(self, f):
        '''
        Load custom unit

        Parameters
        ----------
        f : str
            yml file path

        Returns
        -------
        dict
            custom unit
        '''
        try:
            # update
            self.reference_file = f

            # custom unit
            custom_unit = self._load_custom_conversion_unit(f)

            # if not empty
            if len(custom_unit) == 0:
                return False

            # check key 'CUSTOM-UNIT'
            if 'CUSTOM-UNIT' not in custom_unit.keys():
                raise ValueError("Key 'CUSTOM-UNIT' not found")

            # update custom conversion
            for key, value in custom_unit['CUSTOM-UNIT'].items():
                self._custom_conversions_full[str(key).strip()] = value

            return self._custom_conversions_full

        except Exception as e:
            raise Exception('Loading custom unit failed!, ', e)

    def convert_custom(self, value, from_unit, to_unit):
        '''
        Converts using custom units

        Parameters
        ----------
        value : float
            value
        from_unit : str
            from unit
        to_unit : str
            to unit

        Returns
        -------
        float
            converted value
        '''
        try:
            # looping through all keys in _custom_conversions_full
            for key, custom_unit_dict in self._custom_conversions_full.items():

                # check
                if from_unit in custom_unit_dict and to_unit in custom_unit_dict:
                    return float(value) / float(custom_unit_dict[from_unit]) * float(custom_unit_dict[to_unit])

            raise ValueError("Custom conversion units not found")
        except Exception as e:
            raise Exception('Conversion failed!, ', e)

add_custom_unit(unit, conversion_factor)

Adds a custom unit conversion to the reference dictionary

Parameters

unit : str unit conversion_factor : float conversion factor

Returns

bool True if successful

Source code in pycuc/docs/cucx.py 
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
def add_custom_unit(self, unit, conversion_factor):
    '''
    Adds a custom unit conversion to the reference dictionary

    Parameters
    ----------
    unit : str
        unit
    conversion_factor : float
        conversion factor

    Returns
    -------
    bool
        True if successful
    '''
    try:
        # add
        self._custom_conversions[unit] = conversion_factor
        return True
    except Exception as e:
        raise Exception('Adding new unit failed!, ', e)

check_conversion_block(conversion_block)

Checks conversion block

Parameters

conversion_block : str conversion block

Returns

subgroups : list list of subgroups. [0] = from_unit, [1] = '=>', [2] = to_unit

Source code in pycuc/docs/cucx.py 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
def check_conversion_block(self, conversion_block):
    '''
    Checks conversion block

    Parameters
    ----------
    conversion_block : str
        conversion block

    Returns
    -------
    subgroups : list
        list of subgroups. [0] = from_unit, [1] = '=>', [2] = to_unit
    '''
    try:
        return self.parse_conversion_block(conversion_block)
    except Exception as e:
        raise Exception("Checking conversion block failed!, ", e)

check_reference(reference, dataframe=True)

Checks if the reference is valid

Parameters

reference : str reference name such as pressure, temperature, custom

Returns

reference : dict | dataframe reference details

Source code in pycuc/docs/cucx.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def check_reference(self, reference, dataframe=True):
    '''
    Checks if the reference is valid

    Parameters
    ----------
    reference : str
        reference name such as pressure, temperature, custom

    Returns
    -------
    reference : dict | dataframe
        reference details
    '''
    try:
        # set
        reference = str(reference).strip().upper()

        # sub reference
        sub_reference = None
        if '::' in reference:
            # split
            reference_split = reference.split('::')
            # set
            reference = reference_split[1]
            sub_reference = reference

        # refs
        refs = {
            'PRESSURE': self._pressure_conversions,
            'TEMPERATURE': self._temperature_conversions,
            'CUSTOM': self._custom_conversions_full
        }

        # take all keys
        custom_keys = list(self._custom_conversions_full.keys())
        # all keys
        all_keys = list(set(list(refs.keys()) + custom_keys))

        # check
        if reference not in all_keys:
            raise Exception('Reference not found')

        # if contain ::
        if sub_reference:
            # set
            res = self._custom_conversions_full[sub_reference]
        else:
            # dict
            res = refs[reference]

        if dataframe:
            # Convert dictionary to DataFrame
            df = pd.DataFrame(
                list(res.items()),
                columns=['Unit', 'Value']
            )
            return df
        else:
            return res
    except Exception as e:
        raise Exception(f'Checking {reference} failed!, ', e)

convert(value, from_unit, to_unit, reference=None)

Selects the conversion function

Parameters

value: float value from_unit : str from unit to_unit : str to unit reference : str reference name such as PRESSURE, TEMPERATURE, CUSTOM

Source code in pycuc/docs/cucx.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
def convert(self, value, from_unit, to_unit, reference=None):
    '''
    Selects the conversion function

    Parameters
    ----------
    value: float
        value
    from_unit : str
        from unit
    to_unit : str
        to unit
    reference : str
        reference name such as PRESSURE, TEMPERATURE, CUSTOM
    '''
    try:
        # find reference
        if reference is None:
            reference = self.find_reference(from_unit, to_unit)

        # upper
        reference = reference.upper()

        # reference
        ref = {
            'PRESSURE': self._pressure_conversions,
            'TEMPERATURE': self._temperature_conversions,
            'CUSTOM': self._custom_conversions
        }

        # check
        if reference not in ref.keys():
            raise Exception('Reference not found')

        # reference
        ref_methods = {
            'PRESSURE': lambda x, y, z: self.convert_pressure(x, y, z),
            'TEMPERATURE': lambda x, y, z: self.convert_temperature(x, y, z),
            'CUSTOM': lambda x, y, z: self.convert_custom(x, y, z)
        }

        # check
        if reference not in ref_methods:
            raise Exception('Reference not found')

        # set
        res = ref_methods[reference](value, from_unit, to_unit)

        return res
    except Exception as e:
        raise Exception('Setting conversion function failed!, ', e)

convert_custom(value, from_unit, to_unit)

Converts using custom units

Parameters

value : float value from_unit : str from unit to_unit : str to unit

Returns

float converted value

Source code in pycuc/docs/cucx.py 
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
def convert_custom(self, value, from_unit, to_unit):
    '''
    Converts using custom units

    Parameters
    ----------
    value : float
        value
    from_unit : str
        from unit
    to_unit : str
        to unit

    Returns
    -------
    float
        converted value
    '''
    try:
        # looping through all keys in _custom_conversions_full
        for key, custom_unit_dict in self._custom_conversions_full.items():

            # check
            if from_unit in custom_unit_dict and to_unit in custom_unit_dict:
                return float(value) / float(custom_unit_dict[from_unit]) * float(custom_unit_dict[to_unit])

        raise ValueError("Custom conversion units not found")
    except Exception as e:
        raise Exception('Conversion failed!, ', e)

convert_pressure(value, from_unit, to_unit)

Converts pressure from one unit to another.

Parameters

value : float value from_unit : str from unit to_unit : str to unit

Returns

float converted value

Source code in pycuc/docs/cucx.py 
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
def convert_pressure(self, value, from_unit, to_unit):
    '''
    Converts pressure from one unit to another.

    Parameters
    ----------
    value : float
        value
    from_unit : str
        from unit
    to_unit : str
        to unit

    Returns
    -------
    float
        converted value
    '''
    try:
        # res
        return float(value) / float(self._pressure_conversions[from_unit]) * float(self._pressure_conversions[to_unit])
    except Exception as e:
        raise Exception('Pressure conversion failed!, ', e)

convert_temperature(value, from_unit, to_unit)

Converts temperature from one unit to another.

Parameters

value : float value from_unit : str from unit to_unit : str to unit

Returns

float converted value

Source code in pycuc/docs/cucx.py 
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
def convert_temperature(self, value, from_unit, to_unit):
    '''
    Converts temperature from one unit to another.

    Parameters
    ----------
    value : float
        value
    from_unit : str
        from unit
    to_unit : str
        to unit

    Returns
    -------
    float
        converted value
    '''
    try:
        # set
        value = float(value)

        # Convert to Celsius first
        if from_unit == 'F':
            value = (
                value - self._temperature_conversions[from_unit]) * 5/9
        elif from_unit == 'K':
            value = value + self._temperature_conversions[from_unit]
        elif from_unit == 'R':
            value = (
                value - self._temperature_conversions[from_unit]) * 5/9

        # Convert from Celsius to target unit
        if to_unit == 'F':
            result = value * 9/5 + self._temperature_conversions[to_unit]
        elif to_unit == 'K':
            result = value - self._temperature_conversions[to_unit]
        elif to_unit == 'R':
            result = value * 9/5 + self._temperature_conversions[to_unit]
        else:  # to_unit == 'C'
            result = value

        return result
    except Exception as e:
        raise Exception('Temperature conversion failed!, ', e)

find_reference(from_unit, to_unit)

Finds the conversion function

Parameters

from_unit : str from unit to_unit : str to unit

Returns

reference : str reference name such as pressure, temperature, custom

Source code in pycuc/docs/cucx.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
def find_reference(self, from_unit, to_unit):
    '''
    Finds the conversion function

    Parameters
    ----------
    from_unit : str
        from unit
    to_unit : str
        to unit

    Returns
    -------
    reference : str
        reference name such as pressure, temperature, custom
    '''
    try:
        # reference
        reference = None
        # pressure
        if from_unit in self._pressure_conversions and to_unit in self._pressure_conversions:
            reference = 'PRESSURE'
        # temperature
        elif from_unit in self._temperature_conversions and to_unit in self._temperature_conversions:
            reference = 'TEMPERATURE'
        # custom
        elif from_unit in self._custom_conversions and to_unit in self._custom_conversions:
            reference = 'CUSTOM'
        else:
            # check
            for key, value in self._custom_conversions_full.items():
                if from_unit in value and to_unit in value:
                    reference = 'CUSTOM'

        # check
        if reference is None:
            raise Exception('Conversion units not found')

        return reference
    except Exception as e:
        raise Exception('Finding reference failed!, ', e)

from_to(value, from_unit, to_unit, reference=None)

Converts from one unit to another

Parameters

value : float value from_unit : str from unit to_unit : str to unit

Source code in pycuc/docs/cucx.py 
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
def from_to(self, value, from_unit, to_unit, reference=None):
    '''
    Converts from one unit to another

    Parameters
    ----------
    value : float
        value
    from_unit : str
        from unit
    to_unit : str
        to unit
    '''
    try:
        # convert
        return self.convert(value, from_unit, to_unit, reference)
    except Exception as e:
        raise Exception('Conversion failed!, ', e)

load_custom_unit(f)

Load custom unit

Parameters

f : str yml file path

Returns

dict custom unit

Source code in pycuc/docs/cucx.py 
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
def load_custom_unit(self, f):
    '''
    Load custom unit

    Parameters
    ----------
    f : str
        yml file path

    Returns
    -------
    dict
        custom unit
    '''
    try:
        # update
        self.reference_file = f

        # custom unit
        custom_unit = self._load_custom_conversion_unit(f)

        # if not empty
        if len(custom_unit) == 0:
            return False

        # check key 'CUSTOM-UNIT'
        if 'CUSTOM-UNIT' not in custom_unit.keys():
            raise ValueError("Key 'CUSTOM-UNIT' not found")

        # update custom conversion
        for key, value in custom_unit['CUSTOM-UNIT'].items():
            self._custom_conversions_full[str(key).strip()] = value

        return self._custom_conversions_full

    except Exception as e:
        raise Exception('Loading custom unit failed!, ', e)

to(value, unit_conversion_block, reference=None)

Converts through a unit conversion block

Parameters

value : float value unit_conversion_block : str unit conversion block reference : str reference name such as pressure, temperature, custom

Source code in pycuc/docs/cucx.py 
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
def to(self, value, unit_conversion_block, reference=None):
    '''
    Converts through a unit conversion block

    Parameters
    ----------
    value : float
        value
    unit_conversion_block : str
        unit conversion block
    reference : str
        reference name such as pressure, temperature, custom
    '''
    try:
        # interpret the unit conversion block
        from_unit, _, to_unit = self.check_conversion_block(
            unit_conversion_block)

        # convert
        return self.convert(value, from_unit, to_unit, reference)
    except Exception as e:
        raise Exception('Conversion failed!, ', e)