units package
=============

.. automodule:: brian2.units
    :show-inheritance:


:mod:`allunits` module
----------------------

.. automodule:: brian2.units.allunits
    :show-inheritance:

**Objects**

.. autosummary:: celsius
    :toctree:


:mod:`constants` module
-----------------------

.. automodule:: brian2.units.constants
    :show-inheritance:


:mod:`fundamentalunits` module
------------------------------

.. automodule:: brian2.units.fundamentalunits
    :show-inheritance:

**Classes**

.. autosummary:: Dimension
    :toctree:

.. autosummary:: DimensionMismatchError
    :toctree:

.. autosummary:: Quantity
    :toctree:

.. autosummary:: Unit
    :toctree:

.. autosummary:: UnitRegistry
    :toctree:

**Functions**

.. autosummary:: check_units
    :toctree:

.. autosummary:: fail_for_dimension_mismatch
    :toctree:

.. autosummary:: get_dimensions
    :toctree:

.. autosummary:: get_or_create_dimension
    :toctree:

.. autosummary:: get_unit
    :toctree:

.. autosummary:: get_unit_for_display
    :toctree:

.. autosummary:: have_same_dimensions
    :toctree:

.. autosummary:: in_best_unit
    :toctree:

.. autosummary:: in_unit
    :toctree:

.. autosummary:: is_dimensionless
    :toctree:

.. autosummary:: is_scalar_type
    :toctree:

.. autosummary:: quantity_with_dimensions
    :toctree:

.. autosummary:: register_new_unit
    :toctree:

.. autosummary:: wrap_function_change_dimensions
    :toctree:

.. autosummary:: wrap_function_dimensionless
    :toctree:

.. autosummary:: wrap_function_keep_dimensions
    :toctree:

.. autosummary:: wrap_function_remove_dimensions
    :toctree:

**Objects**

.. autosummary:: DIMENSIONLESS
    :toctree:

.. autosummary:: additional_unit_register
    :toctree:

.. autosummary:: standard_unit_register
    :toctree:

.. autosummary:: user_unit_register
    :toctree:


:mod:`stdunits` module
----------------------

.. automodule:: brian2.units.stdunits
    :show-inheritance:


:mod:`unitsafefunctions` module
-------------------------------

.. automodule:: brian2.units.unitsafefunctions
    :show-inheritance:

**Functions**

.. autosummary:: arange
    :toctree:

.. autosummary:: arccos
    :toctree:

.. autosummary:: arccosh
    :toctree:

.. autosummary:: arcsin
    :toctree:

.. autosummary:: arcsinh
    :toctree:

.. autosummary:: arctan
    :toctree:

.. autosummary:: arctanh
    :toctree:

.. autosummary:: cos
    :toctree:

.. autosummary:: cosh
    :toctree:

.. autosummary:: diagonal
    :toctree:

.. autosummary:: dot
    :toctree:

.. autosummary:: exp
    :toctree:

.. autosummary:: exprel
    :toctree:

.. autosummary:: linspace
    :toctree:

.. autosummary:: log
    :toctree:

.. autosummary:: ravel
    :toctree:

.. autosummary:: sin
    :toctree:

.. autosummary:: sinh
    :toctree:

.. autosummary:: tan
    :toctree:

.. autosummary:: tanh
    :toctree:

.. autosummary:: trace
    :toctree:

.. autosummary:: where
    :toctree:

.. autosummary:: wrap_function_to_method
    :toctree:


