Metadata-Version: 2.4
Name: quantitas
Version: 1.2.0b1
Summary: A practical tool for calculations with physical units
Author: Gakuto
License-Expression: MIT
Project-URL: Repository, https://github.com/Gakuto8/Quantitas
Keywords: quantity,unit
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Dynamic: license-file

# Quantitas

## 概要
Quantitasは、煩雑な単位計算を手軽に実行するためのパッケージです。物理量に対して四則演算などの計算を行ったり、単位変換をしたりできます。また、本パッケージには、自然科学の分野でよく使われる単位や定数の多くがあらかじめ実装されており、ユーザーは自身で定義することなくこれらを使うことができます。

## インストール
```
pip install quantitas
```

## クイックスタート
木星の半径と質量から、木星表面の重力加速度を計算するサンプルコードです。
```python
import quantitas as qt
from quantitas.units import * #Quantitasが収録する全ての単位をインポート
from quantitas import G, M_Jupiter, M_Earth #定数をインポート

r = 71492*km_
g = G*M_Jupiter/r**2

print(g)
#出力: 24.79160264727122 m⋅s^-2
```
単位を表す変数名には末尾にアンダースコア (`_`) が付きます。万有引力定数`G`や木星質量`M_Jupiter`など、よく使われる定数の多くはあらかじめ定義されています。

上のサンプルコードのように物理量は`print`関数で表示することもできますが、物理量を出力するのに特化した`qrint`関数がおすすめです。
```python
from quantitas import qrint

qrint(g)
#出力: 24.79160264727122 m⋅s^-2

qrint(g, [N_, kg_]) #単位を指定すると自動で変換されます
#出力: 24.79160264727122 N⋅kg^-1

qrint([M_Jupiter, M_Earth]) #複数の物理量もまとめて出力できます
#出力: 1.8985138610303162e+27 kg  5.972168401180649e+24 kg
```
単位はユーザーが定義することもできます。`give_symbol`関数を使うことで物理量に文字列の記号を与えることができます。
```python
kph_ = qt.give_symbol(km_/h_, "kph") #キロメートル毎時
qrint(340*m_/s_, kph_)
#出力: 1224.0 kph
```

## もっと詳しく
本パッケージには上で紹介しきれなかった機能や仕様がたくさんあります。Quantitasについてもっと知りたいと思った方は以下をご参照ください。
* [チュートリアル](https://github.com/Gakuto8/Quantitas/blob/main/docs/TUTORIAL.md)
* [仕様書](https://github.com/Gakuto8/Quantitas/blob/main/docs/REFERENCE.md)
* [定数と単位の一覧](https://github.com/Gakuto8/Quantitas/blob/main/docs/CONSTANTS_AND_UNITS.md)

## License
This project is licensed under the MIT License, see the LICENSE.txt file for details.
