Welcome to ‘Just SI Units’ documentation!¶
justunits handles (SI-) units within string occurrences. The module’s justunits tasks are limited to the interchangeability of different unit formatting styles. This module focus just on units, it does not provide unit conversion or anything related to such a topic. It’s purpose is to provide an entry point for a future unit conversion within another module.
justunits major purpose can be shown with 2 graphs. It’s first purpose is to provide a support for different value/attribute and unit separation styles, which can occur within text files.
Note
The current development state of this project is `alpha`. It’s published for a first stress test of 2 major functions.
Towards the beta
naming of modules, classes and methods will change, since the final wording is not done.
Code inspections are not finished.
The documentation is broad or incomplete.
Testing is not complete, as it is added during the first test phase. At this state mostly doctests are applied at class or function level.
Figure 1: Supported separations between an attribute/value and a unit.
The second purpose is to detect SI-units and support 4 major layouts emphasising utf8 with superscripts using a dot as a separator.
Figure 2: Unit representations supported by justunits.
Installation¶
Install the latest release from pip.
$ pip install justunits
- Basic Usage
- Unit styles of justunits
- API reference
- justunits
- DerivedUnit
- AttributeUnitSeparators
- BaseSiUnits
- BareUnit
- create_unit
- from_string
- join_unit
- Prefix
- prefix_base_unit
- reformat_unit
- register_unit
- reset_unit_library
- set_default_attribute_unit_separator
- set_default_unit_style
- SiPrefixes
- SiUnits
- split_unit
- split_unit_text
- to_string
- UnitDividingStyle
- UnitPowerStyle
- UnitSeparationStyle
- UnitStyle
- UnknownUnit
- justunits.AUnit