Metadata-Version: 2.4
Name: qunits
Version: 0.4.0
Summary: A performant, verbose and generic physical unit system.
Author-email: Patrick Müller <pamueller.ikp@gmail.com>
License-Expression: MIT
Project-URL: homepage, https://patmlr.github.io/qunits/
Project-URL: documentation, https://patmlr.github.io/qunits/doc/doc.html
Project-URL: download, https://pypi.org/project/qunits/#files
Project-URL: source, https://github.com/patmlr/qunits
Project-URL: tracker, https://github.com/patmlr/qunits/issues
Keywords: physics,units,quantities,dimensions
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=2.0.2
Requires-Dist: scipy>=1.17.1
Dynamic: license-file

<h1>
<img src="https://raw.githubusercontent.com/patmlr/qunits/main/docs/assets/img/logo.svg" width="300">
</h1><hr>

[![Static Badge](https://img.shields.io/badge/Python-3.12%2B-blue?logo=python&logoColor=white)](https://www.python.org/)
[![Static Badge](https://img.shields.io/badge/License-MIT-slateblue)](https://github.com/patmlr/qunits/blob/main/LICENSE)

## NOTE: Early development. Not fully functional yet.

The [_qunits_](https://pypi.org/project/qunits/) Python package provides a performant, verbose and generic physical unit system.
Tutorials and the API documentation are available on the [_Homepage_](https://patmlr.github.io/qunits/).
Additional example scripts can be found in the example folder on [_GitHub_](https://github.com/patmlr/qunits).

### Getting started

```python
from qunits import u

q = 2 * u.e  # >>> 2.0 e
v = 2e5 * u.m / u.s  # >>> 200000.0 m/s
B = 0.42 * u.mT  # >>> 0.42 mT

F = q * v * B  # >>> 2.69165674512e-17 N
```

### Dependencies

- [_NumPy_](http://www.numpy.org/)
- [_SciPy_](http://www.scipy.org/)

### Modules

- _dimension_: Contains the dimension definitions.
- _registry_: Contains the unit registry `u`.
- _unit_: Contains the `Unit` and the `Quantity` classes.
