pyunitwizard.forms package#

Submodules#

pyunitwizard.forms.api_astropy_unit module#

pyunitwizard.forms.api_astropy_unit.change_value(quantity, value)[source]#

Return an Astropy quantity with updated value and preserved unit.

Parameters:

quantity (astropy.units.Quantity) – Input quantity.
value (int or float or ArrayLike) – New value.

Returns:

Quantity with replaced value and same unit.

Return type:

astropy.units.Quantity

pyunitwizard.forms.api_astropy_unit.compatibility(quantity_or_unit_1, quantity_or_unit_2)[source]#

Check dimensional compatibility between two Astropy objects.

Parameters:

quantity_or_unit_1 (astropy.units.Quantity or astropy.units.UnitBase) – First input.
quantity_or_unit_2 (astropy.units.Quantity or astropy.units.UnitBase) – Second input.

Returns:

True when both objects are equivalent.

Return type:

bool

pyunitwizard.forms.api_astropy_unit.convert(quantity, unit)[source]#

Convert an Astropy quantity to another unit.

Parameters:

quantity (astropy.units.Quantity) – Input quantity.
unit (str or astropy.units.UnitBase) – Target unit.

Returns:

Converted quantity.

Return type:

astropy.units.Quantity

pyunitwizard.forms.api_astropy_unit.dimensionality(quantity_or_unit)[source]#

Return dimensional exponents for an Astropy quantity or unit.

Parameters:: quantity_or_unit (astropy.units.Quantity or astropy.units.UnitBase) – Input quantity or unit.
Returns:: Mapping of fundamental dimensions to exponents.
Return type:: dict

pyunitwizard.forms.api_astropy_unit.get_unit(quantity)[source]#

Return unit of an Astropy quantity.

Parameters:: quantity (astropy.units.Quantity) – Input quantity.
Returns:: Quantity unit.
Return type:: astropy.units.UnitBase

pyunitwizard.forms.api_astropy_unit.get_value(quantity)[source]#

Return numeric value of an Astropy quantity.

Parameters:: quantity (astropy.units.Quantity) – Input quantity.
Returns:: Numeric magnitude.
Return type:: int or float or ArrayLike

pyunitwizard.forms.api_astropy_unit.is_form(quantity_or_unit)[source]#

Check whether an object belongs to Astropy form.

Parameters:: quantity_or_unit (Any) – Candidate object.
Returns:: True if the object is an Astropy quantity or unit.
Return type:: bool

pyunitwizard.forms.api_astropy_unit.is_quantity(quantity_or_unit)[source]#

Check whether an object is an Astropy quantity.

Parameters:: quantity_or_unit (Any) – Candidate object.
Returns:: True when the object is astropy.units.Quantity.
Return type:: bool

pyunitwizard.forms.api_astropy_unit.is_unit(quantity_or_unit)[source]#

Check whether an object is an Astropy unit.

Parameters:: quantity_or_unit (Any) – Candidate object.
Returns:: True when the object is astropy.units.UnitBase.
Return type:: bool

pyunitwizard.forms.api_astropy_unit.make_quantity(value, unit)[source]#

Create an Astropy quantity from value and unit.

Parameters:

value (int or float or ArrayLike) – Quantity value.
unit (str or astropy.units.UnitBase) – Unit definition.

Returns:

Constructed quantity.

Return type:

astropy.units.Quantity

pyunitwizard.forms.api_astropy_unit.quantity_to_openmm_unit(quantity)[source]#

Convert an Astropy quantity to an OpenMM quantity.

Parameters:: quantity (astropy.units.Quantity) – Input quantity.
Returns:: Quantity in OpenMM backend.
Return type:: openmm.unit.Quantity

pyunitwizard.forms.api_astropy_unit.quantity_to_pint(quantity)[source]#

Convert an Astropy quantity to a pint quantity.

Parameters:: quantity (astropy.units.Quantity) – Input quantity.
Returns:: Quantity in pint backend.
Return type:: pint.Quantity

pyunitwizard.forms.api_astropy_unit.quantity_to_string(quantity)[source]#

Convert an Astropy quantity to string form.

Parameters:: quantity (astropy.units.Quantity) – Input quantity.
Returns:: Quantity represented as string.
Return type:: str

pyunitwizard.forms.api_astropy_unit.quantity_to_unyt(quantity)[source]#

Convert an Astropy quantity to a unyt quantity.

Parameters:: quantity (astropy.units.Quantity) – Input quantity.
Returns:: Quantity in unyt backend.
Return type:: unyt.unyt_array or unyt.unyt_quantity

pyunitwizard.forms.api_astropy_unit.string_to_quantity(string)[source]#

Parse a string into an Astropy quantity.

Parameters:: string (str) – Input quantity string.
Returns:: Parsed quantity.
Return type:: astropy.units.Quantity

pyunitwizard.forms.api_astropy_unit.string_to_unit(string)[source]#

Parse a string into an Astropy unit.

Parameters:: string (str) – Input unit string.
Returns:: Parsed unit.
Return type:: astropy.units.UnitBase

pyunitwizard.forms.api_astropy_unit.unit_to_openmm_unit(unit)[source]#

Convert an Astropy unit to an OpenMM unit.

Parameters:: unit (astropy.units.UnitBase) – Input unit.
Returns:: Unit in OpenMM backend.
Return type:: openmm.unit.Unit

pyunitwizard.forms.api_astropy_unit.unit_to_pint(unit)[source]#

Convert an Astropy unit to a pint unit.

Parameters:: unit (astropy.units.UnitBase) – Input unit.
Returns:: Unit in pint backend.
Return type:: pint.Unit

pyunitwizard.forms.api_astropy_unit.unit_to_string(unit)[source]#

Convert an Astropy unit to string form.

Parameters:: unit (astropy.units.UnitBase) – Input unit.
Returns:: Unit represented as string.
Return type:: str

pyunitwizard.forms.api_astropy_unit.unit_to_unyt(unit)[source]#

Convert an Astropy unit to a unyt unit.

Parameters:: unit (astropy.units.UnitBase) – Input unit.
Returns:: Unit in unyt backend.
Return type:: unyt.Unit

pyunitwizard.forms.api_openmm_unit module#

pyunitwizard.forms.api_openmm_unit.change_value(quantity, value)[source]#

Return an OpenMM quantity with updated value and same unit.

Parameters:

quantity (openmm.unit.Quantity) – Input quantity.
value (int or float or ArrayLike) – New numeric value.

Returns:

Quantity with replaced value.

Return type:

openmm.unit.Quantity

pyunitwizard.forms.api_openmm_unit.compatibility(quantity_or_unit_1, quantity_or_unit_2)[source]#

Check whether two quantities or units are compatible.

Parameters:

quantity_or_unit_1 (openmm_unit.Quantity or openmm_unit.Quantity) – A quanitity or a unit.
quantity_or_unit_2 (openmm_unit.Quantity or openmm_unit.Quantity) – A quanitity or a unit.

Returns:

True if they are compatible.

Return type:

bool

pyunitwizard.forms.api_openmm_unit.convert(quantity, unit)[source]#

Converts the quantity to a different unit.

Parameters:

quantity (openmm.unit.Quantity) – A quanitity or a unit.
unit (openmm.unit.Unit) – The unit to convert to.

Returns:

The converted quantity.

Return type:

openmm.unit.Quantity

pyunitwizard.forms.api_openmm_unit.dimensionality(quantity_or_unit)[source]#

Returns the dimensionality of the quantity or unit.

Parameters:: quantity_or_unit (openmm_unit.Quantity or openmm_unit.Unit) – A quanitity or a unit
Returns:: dimensionality_dict – Dictionary which keys are fundamental units and values are the exponent of each unit in the quantity.
Return type:: dict

pyunitwizard.forms.api_openmm_unit.get_unit(quantity)[source]#

Returns the units of the quantity.

Parameters:: quantity (openmm.unit.Quantity) – A quanitity or a unit.
Returns:: The unit.
Return type:: openmm.unit.Unit

pyunitwizard.forms.api_openmm_unit.get_value(quantity)[source]#

Returns the value of the quantity.

Parameters:: quantity (openmm.unit.Quantity) – A quanitity or a unit.
Returns:: The value.
Return type:: int, float or ArrrayLike

pyunitwizard.forms.api_openmm_unit.is_form(quantity_or_unit)[source]#

Check whether an object belongs to OpenMM form.

Parameters:: quantity_or_unit (Any) – Candidate object.
Returns:: True if the object is an OpenMM quantity or unit.
Return type:: bool

pyunitwizard.forms.api_openmm_unit.is_quantity(quantity_or_unit)[source]#

Check whether a quantity or unit is an openmm quantity.

Parameters:: quantity_or_unit (Any) – A quanitity or a unit
Returns:: True if it’s an openmm.unit.Quantity
Return type:: bool

pyunitwizard.forms.api_openmm_unit.is_unit(quantity_or_unit)[source]#

Check whether a quantity or unit is an openmm unit.

Parameters:: quantity_or_unit (Any) – A quanitity or a unit
Returns:: True if its an openmm.unit.Unit
Return type:: bool

pyunitwizard.forms.api_openmm_unit.make_quantity(value, unit)[source]#

Returns an openmm quantity.

Parmeters#

value: int, float or ArrayLike: The value of the quantity.
unitopenmm_unit.Unit: The unit.

returns:: The quantity.
rtype:: openmm_unit.Quantity

Examples

>>> make_quantity(1.0, openmm_unit.nanometer)

Parameters:

value (int | float | ArrayLike)
unit (Unit)

Return type:

Quantity

pyunitwizard.forms.api_openmm_unit.quantity_to_astropy_units(quantity)[source]#

Transform an OpenMM quantity into an Astropy quantity.

Parameters:: quantity (openmm.unit.Quantity) – Input quantity in OpenMM form.
Returns:: Converted quantity in Astropy form.
Return type:: astropy.units.Quantity

pyunitwizard.forms.api_openmm_unit.quantity_to_pint(quantity)[source]#

Transform a quantity from openmm.unit to a pint quantity.

Parameters:: quantity (openmm.unit.Quantity) – A quanitity.
Returns:: The quantity.
Return type:: pint.Quantity

pyunitwizard.forms.api_openmm_unit.quantity_to_string(quantity)[source]#

Convert a quantity to string.

Parameters:: quantity (openmm_unit.Quantity) – A quanitity.
Returns:: The quantitity as a string.
Return type:: str

pyunitwizard.forms.api_openmm_unit.quantity_to_unyt(quantity)[source]#

Transform a quantity from openmm.unit to a unyt quantity.

Parameters:: quantity (openmm.unit.Quantity) – A quanitity or a unit.
Returns:: The quantity.
Return type:: unyt_array or unyt_quantity

pyunitwizard.forms.api_openmm_unit.string_to_quantity(string)[source]#

Raise parser error for OpenMM string quantities.

Parameters:: string (str) – Input string quantity.
Returns:: This function never returns.
Return type:: openmm.unit.Quantity
Raises:: LibraryWithoutParserError – OpenMM backend has no native string parser in this layer.

pyunitwizard.forms.api_openmm_unit.string_to_unit(string)[source]#

Raise parser error for OpenMM string units.

Parameters:: string (str) – Input string unit.
Returns:: This function never returns.
Return type:: openmm.unit.Unit
Raises:: LibraryWithoutParserError – OpenMM backend has no native string parser in this layer.

pyunitwizard.forms.api_openmm_unit.unit_to_astropy_units(unit)[source]#

Transform an OpenMM unit into an Astropy unit.

Parameters:: unit (openmm.unit.Unit) – Input unit in OpenMM form.
Returns:: Converted unit in Astropy form.
Return type:: astropy.units.UnitBase

pyunitwizard.forms.api_openmm_unit.unit_to_pint(unit)[source]#

Transform a unit from openmm.unit to a pint unit.

Parameters:: unit (openmm.unit.Unit) – A unit.
Returns:: The unit.
Return type:: pint.Unit

pyunitwizard.forms.api_openmm_unit.unit_to_string(unit)[source]#

Convert a unit to string.

Parameters:: unit (openmm_unit.Unit) – A unit.
Returns:: The quantitity as a string.
Return type:: str

pyunitwizard.forms.api_openmm_unit.unit_to_unyt(unit)[source]#

Transform a unit from openmm.unit to a unyt unit.

Parameters:: unit (openmm.unit.Unit) – A unit.
Returns:: The unit.
Return type:: unyt_unit

pyunitwizard.forms.api_physipy module#

pyunitwizard.forms.api_pint module#

pyunitwizard.forms.api_pint.change_value(quantity, value)[source]#

Return a pint quantity with updated value and preserved unit.

Parameters:

quantity (pint.Quantity) – Input quantity.
value (int or float or ArrayLike) – New numeric value.

Returns:

Quantity with replaced magnitude and same unit.

Return type:

pint.Quantity

pyunitwizard.forms.api_pint.compatibility(quantity_or_unit_1, quantity_or_unit_2)[source]#

Check whether two quantities or units are compatible.

Parameters:

quantity_or_unit_1 (openmm_unit.Quantity or openmm_unit.Quantity) – A quanitity or a unit.
quantity_or_unit_2 (openmm_unit.Quantity or openmm_unit.Quantity) – A quanitity or a unit.

Returns:

True if they are compatible.

Return type:

bool

pyunitwizard.forms.api_pint.convert(quantity, unit_name)[source]#

Converts the quantity to a different unit.

Parameters:

quantity (pint.Quantity) – A quanitity or a unit.
unit (str) – The unit to convert to.
unit_name (str)

Returns:

The converted quantity.

Return type:

pint.Quantity

pyunitwizard.forms.api_pint.dimensionality(quantity_or_unit)[source]#

Returns the dimensionality of the quantity or unit.

Parameters:: quantity_or_unit (pint.Quantity or pint.Unit) – A quanitity or a unit
Returns:: dimensionality_dict – Dictionary which keys are fundamental units and values are the exponent of each unit in the quantity.
Return type:: dict

pyunitwizard.forms.api_pint.get_unit(quantity)[source]#

Returns the units of the quantity.

Parameters:: quantity (pint.Quantity) – A quanitity or a unit.
Returns:: The unit.
Return type:: pint.Unit

pyunitwizard.forms.api_pint.get_value(quantity)[source]#

Returns the value of the quantity.

Parameters:: quantity (pint.Quantity) – A quanitity or a unit.
Returns:: The value.
Return type:: int, float or ArrrayLike

pyunitwizard.forms.api_pint.is_form(quantity_or_unit)[source]#

Check whether an object belongs to pint form.

Parameters:: quantity_or_unit (Any) – Candidate object.
Returns:: True if the object is a pint quantity or unit.
Return type:: bool

pyunitwizard.forms.api_pint.is_quantity(quantity_or_unit)[source]#

Check whether a quantity or unit is an pint quantity.

Parameters:: quantity_or_unit (Any) – A quanitity or a unit
Returns:: True if it’s an pint quantity.
Return type:: bool

pyunitwizard.forms.api_pint.is_unit(quantity_or_unit)[source]#

Check whether a quantity or unit is a pint unit.

Parameters:: quantity_or_unit (Any) – A quanitity or a unit
Returns:: True if its an openmm.unit.Unit
Return type:: bool

pyunitwizard.forms.api_pint.make_quantity(value, unit)[source]#

Returns a pint quantity.

Parmeters#

value: int, float or ArrayLike: The value of the quantity.
unitstr: Name of the unit.

returns:: The quantity.
rtype:: pint.Quantity

Examples

>>> make_quantity(1.0, "nanometer")

Parameters:

value (float | int | ArrayLike)
unit (str)

Return type:

Quantity

pyunitwizard.forms.api_pint.quantity_to_astropy_units(quantity)[source]#

Transform a pint quantity into an Astropy quantity.

Parameters:: quantity (pint.Quantity) – Input quantity in pint form.
Returns:: Converted quantity in Astropy form.
Return type:: astropy.units.Quantity

pyunitwizard.forms.api_pint.quantity_to_openmm_unit(quantity)[source]#

Transform a quantity from a pint quantity to a openmm.unit quantity.

Parameters:: quantity (pint.Quantity) – A quanitity.
Returns:: The quantity.
Return type:: openmm_unit.Quantity

pyunitwizard.forms.api_pint.quantity_to_physipy(quantity)[source]#

Transform a pint quantity into a physipy quantity.

Parameters:: quantity (Quantity)

pyunitwizard.forms.api_pint.quantity_to_quantities(quantity)[source]#

Transform a pint quantity into a quantities quantity.

Parameters:: quantity (Quantity)

pyunitwizard.forms.api_pint.quantity_to_string(quantity_or_item)[source]#

Convert a quantity to string.

Parameters:: quantity_or_item (pint.Quantity) – A quanitity or a unit.
Returns:: The quantitity as a string.
Return type:: str

pyunitwizard.forms.api_pint.quantity_to_unyt(quantity)[source]#

Transform a quantity from a pint quantity to a unyt quantity.

Parameters:: quantity (pint.Quantity) – A quantity.
Returns:: The unyt quantity
Return type:: unyt_array or unyt_quantity

pyunitwizard.forms.api_pint.string_to_quantity(string)[source]#

Get a quantity from a string.

Parameters:: string (str) – A string with the quantity.
Returns:: The quantity.
Return type:: pint.Quantity

pyunitwizard.forms.api_pint.string_to_unit(string)[source]#

Get a unit from a string.

Parameters:: string (str) – A string with the unit.
Returns:: The unit.
Return type:: pint.Unit

pyunitwizard.forms.api_pint.unit_to_astropy_units(unit)[source]#

Transform a pint unit into an Astropy unit.

Parameters:: unit (pint.Unit) – Input unit in pint form.
Returns:: Converted unit in Astropy form.
Return type:: astropy.units.UnitBase

pyunitwizard.forms.api_pint.unit_to_openmm_unit(unit)[source]#

Transform a unit from a pint unit to a openmm.unit unit.

Parameters:: unit (pint.Unit) – A unit.
Returns:: The unit.
Return type:: openmm_unit.Unit

pyunitwizard.forms.api_pint.unit_to_physipy(unit)[source]#

Transform a pint unit into a physipy unit-like object.

Parameters:: unit (Unit)

pyunitwizard.forms.api_pint.unit_to_quantities(unit)[source]#

Transform a pint unit into a quantities unit-like object.

Parameters:: unit (Unit)

pyunitwizard.forms.api_pint.unit_to_string(unit_or_item)[source]#

Convert a unit to string.

Parameters:: unit_or_item (pint.Unit) – A unit.
Returns:: The unit as a string.
Return type:: str

pyunitwizard.forms.api_pint.unit_to_unyt(unit)[source]#

Transform a unit from a pint unit to a unyt unit.

Parameters:: unit (pint.Unit) – A unit.
Returns:: The unyt quantity
Return type:: unyt_array or unyt_quantity

pyunitwizard.forms.api_quantities module#

pyunitwizard.forms.api_string module#

pyunitwizard.forms.api_string.change_value(quantity, value)[source]#

Return a string quantity with updated value and preserved unit.

Parameters:

quantity (str) – Input quantity in string form.
value (int or float or ArrayLike) – New numeric value.

Returns:

Quantity with replaced value and original unit.

Return type:

str

pyunitwizard.forms.api_string.compatibility(quantity_or_unit_1, quantity_or_unit_2)[source]#

Check whether two quantities or units are compatible.

Parameters:

quantity_or_unit_1 (str) – A quanitity or a unit.
quantity_or_unit_2 (str) – A quanitity or a unit.

Returns:

True if they are compatible.

Return type:

bool

pyunitwizard.forms.api_string.convert(quantity, unit_name)[source]#

Converts the quantity to a different unit.

Parameters:

quantity (str) – A quanitity-
unit (str) – The unit to convert to.
unit_name (str)

Returns:

The converted quantity.

Return type:

str

pyunitwizard.forms.api_string.dimensionality(quantity_or_unit)[source]#

Returns the dimensionality of the quantity or unit.

Parameters:: quantity_or_unit (str) – A quanitity or a unit
Returns:: dimensionality_dict – Dictionary which keys are fundamental units and values are the exponent of each unit in the quantity.
Return type:: dict

pyunitwizard.forms.api_string.get_unit(quantity)[source]#

Returns the units of the quantity.

Parameters:: quantity (pint.Quantity) – A quanitity or a unit.
Returns:: The unit.
Return type:: pint.Unit

pyunitwizard.forms.api_string.get_value(quantity)[source]#

Returns the value of the quantity.

Parameters:: quantity (pint.Quantity) – A quanitity or a unit.
Returns:: The value.
Return type:: int, float or ArrrayLike

pyunitwizard.forms.api_string.is_form(quantity_or_unit)[source]#

Check whether an object belongs to the string form.

Parameters:: quantity_or_unit (Any) – Candidate object.
Returns:: True when the object is a Python string.
Return type:: bool

pyunitwizard.forms.api_string.is_quantity(quantity_or_unit)[source]#

Check whether a string is a quantity.

Parameters:: quantity_or_unit (Any) – A quanitity or a unit
Returns:: True if it’s a quantity.
Return type:: bool

pyunitwizard.forms.api_string.is_unit(quantity_or_unit)[source]#

Check whether a string is a unit.

Parameters:: quantity_or_unit (str) – A quanitity or a unit
Returns:: True if its a unit.
Return type:: bool

pyunitwizard.forms.api_string.make_quantity(value, unit_name)[source]#

Returns a string quantity.

Parmeters#

value: int, float or ArrayLike: The value of the quantity.
unitstr: Name of the unit.

returns:: The quantity.
rtype:: str

Examples

>>> make_quantity(1.0, "nanometer")

Parameters:

value (int | float | ArrayLike)
unit_name (str)

Return type:

str

pyunitwizard.forms.api_string.quantity_to_astropy_units(quantity)[source]#

Convert a string quantity into an Astropy quantity.

Parameters:: quantity (str) – Quantity in string form.
Returns:: Quantity represented in Astropy backend.
Return type:: astropy.units.Quantity

pyunitwizard.forms.api_string.quantity_to_openmm_unit(quantity)[source]#

Convert a string quantity into an OpenMM quantity.

Parameters:: quantity (str) – Quantity in string form.
Returns:: Quantity represented in OpenMM units.
Return type:: openmm.unit.Quantity

pyunitwizard.forms.api_string.quantity_to_physipy(quantity)[source]#

Convert a string quantity into a physipy quantity.

Parameters:: quantity (str)

pyunitwizard.forms.api_string.quantity_to_pint(quantity)[source]#

Transform a quantity from a string quantity to a pint quantity.

Parameters:: quantity (str) – A quanitity.
Returns:: The quantity.
Return type:: pint.Quantity

pyunitwizard.forms.api_string.quantity_to_quantities(quantity)[source]#

Convert a string quantity into a quantities quantity.

Parameters:: quantity (str)

pyunitwizard.forms.api_string.quantity_to_unyt(quantity)[source]#

Convert a string quantity into a unyt quantity.

Parameters:: quantity (str) – Quantity in string form.
Returns:: Quantity represented in unyt backend.
Return type:: unyt.unyt_array or unyt.unyt_quantity

pyunitwizard.forms.api_string.unit_to_astropy_units(unit)[source]#

Convert a string unit into an Astropy unit.

Parameters:: unit (str) – Unit name in string form.
Returns:: Unit represented in Astropy backend.
Return type:: astropy.units.UnitBase

pyunitwizard.forms.api_string.unit_to_openmm_unit(unit)[source]#

Convert a string unit into an OpenMM unit.

Parameters:: unit (str) – Unit name in string form.
Returns:: Unit represented in OpenMM backend.
Return type:: openmm.unit.Unit

pyunitwizard.forms.api_string.unit_to_physipy(unit)[source]#

Convert a string unit into a physipy unit-like object.

Parameters:: unit (str)

pyunitwizard.forms.api_string.unit_to_pint(unit)[source]#

Transform a quantity from a string quantity to a pint quantity.

Parameters:

quantity (str) – A quanitity.
unit (str)

Returns:

The quantity.

Return type:

pint.Quantity

pyunitwizard.forms.api_string.unit_to_quantities(unit)[source]#

Convert a string unit into a quantities unit-like object.

Parameters:: unit (str)

pyunitwizard.forms.api_string.unit_to_unyt(quantity)[source]#

Convert a string unit into a unyt unit.

Parameters:: quantity (str) – Unit name in string form.
Returns:: Unit represented in unyt backend.
Return type:: unyt.Unit

pyunitwizard.forms.api_unyt module#

pyunitwizard.forms.api_unyt.change_value(quantity, value)[source]#

Return a unyt quantity with updated value and preserved unit.

Parameters:

quantity (unyt.unyt_array or unyt.unyt_quantity) – Input quantity.
value (int or float or ArrayLike) – New numeric value.

Returns:

Quantity with replaced value and same unit.

Return type:

unyt.unyt_array or unyt.unyt_quantity

pyunitwizard.forms.api_unyt.compatibility(quantity_or_unit_1, quantity_or_unit_2)[source]#

Check whether two quantities or units are compatible.

Parameters:

quantity_or_unit_1 (unyt_array or unyt_quantity or unyt_unit) – A quanitity or a unit.
quantity_or_unit_2 (unyt_array or unyt_quantity or unyt_unit) – A quanitity or a unit.

Returns:

True if they are compatible.

Return type:

bool

pyunitwizard.forms.api_unyt.convert(quantity, unit_name)[source]#

Converts the quantity to a different unit.

Parameters:

quantity (unyt_array or unyt_quantity) – A quanitity or a unit.
unit (str) – The unit to convert to.
unit_name (str)

Returns:

The converted quantity.

Return type:

unyt_array or unyt_quantity

pyunitwizard.forms.api_unyt.dimensionality(quantity_or_unit)[source]#

Returns the dimensionality of the quantity or unit.

Parameters:: quantity_or_unit (pint.Quantity or pint.Unit) – A quanitity or a unit
Returns:: dimensionality_dict – Dictionary which keys are fundamental units and values are the exponent of each unit in the quantity.
Return type:: dict

pyunitwizard.forms.api_unyt.get_unit(quantity)[source]#

Returns the units of the quantity.

Parameters:: quantity (unyt_array or unyt_quantity) – A quanitity or a unit.
Returns:: The unit.
Return type:: unyt_unit

pyunitwizard.forms.api_unyt.get_value(quantity)[source]#

Returns the value of the quantity.

Parameters:: quantity (unyt_array or unyt_quantity) – A quanitity or a unit.
Returns:: The value.
Return type:: int, float or ArrrayLike

pyunitwizard.forms.api_unyt.is_form(quantity_or_unit)[source]#

Check whether an object belongs to unyt form.

Parameters:: quantity_or_unit (Any) – Candidate object.
Returns:: True if the object is a unyt quantity or unit.
Return type:: bool

pyunitwizard.forms.api_unyt.is_quantity(quantity_or_unit)[source]#

Check whether a quantity or unit is a unyt quantity.

Parameters:: quantity_or_unit (Any) – A quanitity or a unit
Returns:: True if it is a unyt.unyt_array or unyt.unyt_quantity.
Return type:: bool

pyunitwizard.forms.api_unyt.is_unit(quantity_or_unit)[source]#

Check whether a quantity or unit is a unyt unit.

Parameters:: quantity_or_unit (Any) – A quanitity or a unit.
Returns:: True if it is a unyt_unit.
Return type:: bool

pyunitwizard.forms.api_unyt.make_quantity(value, unit)[source]#

Returns a unyt quantity.

Parmeters#

value: int, float or ArrayLike: The value of the quantity.
unitunyt_unit or str: The unit.

returns:: The quantity.
rtype:: unyt_array or unyt_quantity

Examples

>>> make_quantity(1.0, "nm")

Parameters:

value (int | float | ArrayLike)
unit (str | Unit)

Return type:

unyt_array | unyt_quantity

pyunitwizard.forms.api_unyt.quantity_to_astropy_units(quantity)[source]#

Transform a unyt quantity into an Astropy quantity.

Parameters:: quantity (unyt.unyt_array or unyt.unyt_quantity) – Input quantity in unyt form.
Returns:: Converted quantity in Astropy form.
Return type:: astropy.units.Quantity

pyunitwizard.forms.api_unyt.quantity_to_openmm_unit(quantity)[source]#

Transform a quantity from unyt to an openmm.unit quantity.

Parameters:: quantity (unyt_array or unyt_quantity) – A quanitity.
Returns:: The quantity.
Return type:: openmm.unit.Quantity

pyunitwizard.forms.api_unyt.quantity_to_pint(quantity)[source]#

Transform a quantity from unyt to a pint quantity.

Parameters:: quantity (unyt_array or unyt_quantity) – A quanitity.
Returns:: The quantity.
Return type:: pint.Quantity

pyunitwizard.forms.api_unyt.quantity_to_string(quantity)[source]#

Convert a quantity to string.

Parameters:: quantity (unyt_array or unyt_quantity) – A quanitity or a unit.
Returns:: The quantitity as a string.
Return type:: str

pyunitwizard.forms.api_unyt.string_to_quantity(string)[source]#

Raise parser error for unyt string quantities.

Parameters:: string (str) – Input quantity string.
Returns:: This function never returns.
Return type:: unyt.unyt_quantity
Raises:: LibraryWithoutParserError – Unyt backend has no parser in this layer.

pyunitwizard.forms.api_unyt.string_to_unit(string)[source]#

Raise parser error for unyt string units.

Parameters:: string (str) – Input unit string.
Returns:: This function never returns.
Return type:: unyt.Unit
Raises:: LibraryWithoutParserError – Unyt backend has no parser in this layer.

pyunitwizard.forms.api_unyt.unit_to_astropy_units(unit)[source]#

Transform a unyt unit into an Astropy unit.

Parameters:: unit (unyt.Unit) – Input unit in unyt form.
Returns:: Converted unit in Astropy form.
Return type:: astropy.units.UnitBase

pyunitwizard.forms.api_unyt.unit_to_openmm_unit(unit)[source]#

Transform a unit from unyt to a openmm.unit unit.

Parameters:: unit (unyt_unit) – A unit.
Returns:: The unit.
Return type:: openmm_unit.Unit

pyunitwizard.forms.api_unyt.unit_to_pint(unit)[source]#

Transform a unit from unyt to a pint unit.

Parameters:: unit (unyt_unit) – A unit.
Returns:: The unit.
Return type:: pint.Unit

pyunitwizard.forms.api_unyt.unit_to_string(unit)[source]#

Convert a unit to string.

Parameters:: unit (unyt_unit) – A unit.
Returns:: The unit as a string.
Return type:: str

pyunitwizard.forms.template_api_form module#

pyunitwizard.forms.template_api_form.compatibility(quantity_or_unit_1, quantity_or_unit_2)[source]#

pyunitwizard.forms.template_api_form.convert(quantity, unit_name)[source]#

pyunitwizard.forms.template_api_form.dimensionality(quantity_or_unit)[source]#

pyunitwizard.forms.template_api_form.get_unit(quantity)[source]#

pyunitwizard.forms.template_api_form.get_value(quantity)[source]#

pyunitwizard.forms.template_api_form.is_quantity(quantity_or_unit)[source]#

pyunitwizard.forms.template_api_form.is_unit(quantity_or_unit)[source]#

pyunitwizard.forms.template_api_form.make_quantity(value, unit_name)[source]#

pyunitwizard.forms.template_api_form.string_to_quantity(string)[source]#

pyunitwizard.forms.template_api_form.to_string(unit)[source]#

Module contents#

pyunitwizard.forms.load_library(library)[source]#

Loads a library. This means that it updates all dictionaries defined above with their respective values for the library.

Parameters:: library (str) – Name of the library backend to load.
Returns:: Internal forms dispatch dictionaries are updated in place.
Return type:: None