gypt_matplotlib 0.2.0__tar.gz → 0.2.2__tar.gz

{gypt_matplotlib-0.2.0 → gypt_matplotlib-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gypt_matplotlib
-Version: 0.2.0
+Version: 0.2.2
 Summary: A small addon for matplotlib that can be used for the GYPT.
 License: MIT
 Keywords: Albert Unruh,GYPT,German Young Physicists' Tournament,matplotlib,addon
@@ -114,3 +114,27 @@ with gypt.auto_save_and_show("path/to/file.png"):
     ...
 ```
 
+#### Using ``utils``
+This library offers multiple utilities which can be used.
+The following utils are included:
+- [``axes_label``](#axes_label)
+- [``tex``](#tex)
+
+##### ``axes_label``
+```python
+import gypt_matplotlib as gypt
+
+# with a unit
+print(gypt.axes_label("v", unit=r"\frac{m}{s}"))  # $v$ in $\frac{m}{s}$
+
+# with arbitrary unit
+print(gypt.axes_label("I", is_au=True))  # $I$ in $\text{a.u.}$
+```
+
+##### ``tex``
+```python
+import gypt_matplotlib as gypt
+
+print(gypt.tex(r"e^{i\pi}+1=0"))  # $e^{i\pi}+1=0$
+```
+

{gypt_matplotlib-0.2.0 → gypt_matplotlib-0.2.2}/README.md

@@ -82,3 +82,27 @@ with gypt.auto_save_and_show("path/to/file.png"):
     # This context manager automatically calls ``plt.savefig()``, ``plt.show()`` and ``plt.close()``.
     ...
 ```
+
+#### Using ``utils``
+This library offers multiple utilities which can be used.
+The following utils are included:
+- [``axes_label``](#axes_label)
+- [``tex``](#tex)
+
+##### ``axes_label``
+```python
+import gypt_matplotlib as gypt
+
+# with a unit
+print(gypt.axes_label("v", unit=r"\frac{m}{s}"))  # $v$ in $\frac{m}{s}$
+
+# with arbitrary unit
+print(gypt.axes_label("I", is_au=True))  # $I$ in $\text{a.u.}$
+```
+
+##### ``tex``
+```python
+import gypt_matplotlib as gypt
+
+print(gypt.tex(r"e^{i\pi}+1=0"))  # $e^{i\pi}+1=0$
+```

{gypt_matplotlib-0.2.0 → gypt_matplotlib-0.2.2}/gypt_matplotlib/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.2.0"
+__version__ = "0.2.2"
 __description__ = "A small addon for matplotlib that can be used for the GYPT."
 __license__ = "MIT"
 __authors__ = ["Keenan Noack <AlbertUnruh@pm.me>"]

{gypt_matplotlib-0.2.0 → gypt_matplotlib-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gypt_matplotlib"
-version = "0.2.0"
+version = "0.2.2"
 description = "A small addon for matplotlib that can be used for the GYPT."
 authors = [
     {name = "Keenan Noack", email = "AlbertUnruh@pm.me"}