Updated the documentation

tueboesen · Mar 16, 2023 · 0766f80 · 0766f80
1 parent 7cd4fea
commit 0766f80
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -1,5 +1,5 @@
 # .github/workflows/build.yaml
-name: multibodypendulum CI
+name: Testing CI
 
 on:
   push:

diff --git a/README.md b/README.md
@@ -24,16 +24,17 @@ and the energy:
 ## Quick start
 A quick usecase to simulate a 5 pendulum system could look like this
 
+    import multibodypendulum as mbp
     n = 5
     dt = 0.001
     g = 9.82
-    mbp = MultiBodyPendulum(n, dt,g=g)
+    model = mbp.MultiBodyPendulum(n, dt,g=g)
     theta0 = 0.5*math.pi*torch.ones(n)
     dtheta0 = 0.0*torch.ones(n)
     nsteps = 100
-    times, thetas, dthetas = mbp.simulate(nsteps,theta0,dtheta0)
-    mbp.plot_energy()
-    mbp.animate_pendulum()
+    times, thetas, dthetas = model.simulate(nsteps,theta0,dtheta0)
+    model.plot_energy()
+    model.animate_pendulum()
 
 ## Limitations
 The code has some limitations:

diff --git a/multibodypendulum/__init__.py b/multibodypendulum/__init__.py
@@ -0,0 +1 @@
+from npendul import MultiBodyPendulum