docs: python get started

Author: lukasberbuer

bindings/python/examples/features_minimal.py

@@ -0,0 +1,21 @@
+import numpy as np
+import openae.features
+
+# generate random data
+rng = np.random.default_rng()
+timedata = rng.normal(0, 1, 1024)
+
+# compute spectrum
+spectrum = np.fft.rfft(timedata)
+
+# generate input for feature extraction algorithms
+input_ = openae.features.Input(
+    samplerate=1.0,
+    timedata=timedata,
+    spectrum=spectrum,
+)
+
+# compute features
+print(openae.features.rms(input_))
+print(openae.features.spectral_centroid(input_))
+print(openae.features.spectral_flatness(input_))

docs/index.rst

@@ -17,6 +17,7 @@ Contents
     :maxdepth: 1
     :caption: Python
 
+    python/get-started
     python/api
 
 Indices and tables

docs/python/get-started.md

@@ -0,0 +1,14 @@
+# Get Started
+
+## Install
+
+The Python library can be easily installed with [PyPI](https://pypi.org/project/openae/):
+
+```shell
+$ pip install openae
+```
+
+## Minimal example
+
+```{literalinclude} ../../bindings/python/examples/features_minimal.py
+```