Merge pull request #4 from ShuN6211/readme_sample_code

Readme sample code
ShuN6211 · Jan 3, 2023 · 92fcb0b · 92fcb0b
2 parents 85cbc9d + 4499c32
commit 92fcb0b
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -43,5 +43,23 @@ You can install via [PyPI](https://pypi.org/). For example,
  $ pip install  sc-vortex-2d 
 ```
 
+## Usage
+```
+"""Sample python code"""
+
+from sc_vortex_2d.vortex import VortexInstanceT03
+from scipy import interpolate
+
+instance: VortexInstanceT03 = VortexInstanceT03()
+
+delta: interpolate.CubicSpline = instance.get_pair_potential() 
+
+e0: float = instance.get_ith_eigen_energy(0) # lowest energy level in the region of e > 0.
+
+u0, v0 = instance.get_ith_eigen_func(0) # get wave functions
+
+params = instance.Parameters # Parameters of the system. Enum.
+
+```
 ## Link
 https://webpark1378.sakura.ne.jp/