add celsius to kelvin transform function

brainunit/__init__.py

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ==============================================================================
-from __future__ import annotations
 
 __version__ = "0.0.2"
 
@@ -23,12 +22,14 @@
 from . import math
 from ._base import *
 from ._base import __all__ as _base_all
+from ._celsius import *
+from ._celsius import __all__ as _celsius_all
 from ._unit_common import *
 from ._unit_common import __all__ as _common_all
 from ._unit_constants import *
 from ._unit_constants import __all__ as _constants_all
 from ._unit_shortcuts import *
 from ._unit_shortcuts import __all__ as _std_units_all
 
-__all__ = ['math'] + _common_all + _std_units_all + _constants_all + _base_all
-del _common_all, _std_units_all, _constants_all, _base_all
+__all__ = ['math'] + _common_all + _std_units_all + _constants_all + _base_all + _celsius_all
+del _common_all, _std_units_all, _constants_all, _base_all, _celsius_all

brainunit/_celsius.py

@@ -0,0 +1,64 @@
+# Copyright 2024 BDP Ecosystem Limited. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+
+
+import jax.typing
+
+from ._base import Quantity
+from ._unit_common import kelvin
+
+__all__ = [
+  "celsius2kelvin",
+  "kelvin2celsius",
+]
+
+
+def celsius2kelvin(celsius: jax.typing.ArrayLike) -> Quantity:
+  """
+  Convert Celsius value to kelvin value.
+
+  Parameters
+  ----------
+  celsius : jax.typing.ArrayLike
+    The celsius value to convert.
+
+  Returns
+  -------
+    Quantity: The converted value.
+
+  """
+  if isinstance(celsius, Quantity):
+    raise TypeError("The input value should be not be a Quantity.")
+  return (celsius + 273.15) * kelvin
+
+
+def kelvin2celsius(value: Quantity) -> jax.typing.ArrayLike:
+  """
+  Convert kelvin value to Celsius value.
+
+  Parameters
+  ----------
+  value : Quantity
+    The kelvin value to convert.
+
+  Returns
+  -------
+    Quantity: The converted value.
+
+  """
+  if not isinstance(value, Quantity) and value.unit != kelvin:
+    raise TypeError("The input value should be a Quantity with kelvin.")
+  return value.mantissa - 273.15
+

brainunit/_celsius_test.py

@@ -0,0 +1,33 @@
+# Copyright 2024 BDP Ecosystem Limited. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+
+
+import brainunit as u
+
+
+def test1():
+  a = u.celsius2kelvin(0)
+  assert a == 273.15 * u.kelvin
+
+  b = u.celsius2kelvin(-100)
+  assert b == 173.15 * u.kelvin
+
+
+def test2():
+  a = u.kelvin2celsius(273.15 * u.kelvin)
+  assert a == 0
+
+  b = u.kelvin2celsius(173.15 * u.kelvin)
+  assert b == -100

brainunit/math/_fun_accept_unitless.py

@@ -167,7 +167,7 @@ def exp2(
     unit_to_scale: Optional[Unit] = None,
 ) -> jax.Array:
   """
-  Calculate 2**p for all p in the input quantity or array.
+  Calculate ``2**p`` for all p in the input quantity or array.
 
   Parameters
   ----------
@@ -192,6 +192,8 @@ def expm1(
   """
   Calculate the exponential of the input elements minus 1.
 
+  Calculate ``exp(x) - 1`` for all elements in the array.
+
   Parameters
   ----------
   x : array_like, Quantity
@@ -261,6 +263,8 @@ def log1p(
   """
   Natural logarithm of 1 + the input elements.
 
+  Calculates ``log(1 + x)``.
+
   Parameters
   ----------
   x : array_like, Quantity

docs/index.rst

@@ -141,7 +141,7 @@ See also the BDP ecosystem
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 
-We are building the `BDP ecosystem <https://ecosystem-for-brain-dynamics.readthedocs.io/>`_:
+We are building the `BDP ecosystem <https://ecosystem-for-brain-dynamics.readthedocs.io/>`_.