Merge pull request #13 from dc2917/update_readme_demo

Show calculation and plot of pressure on readme
dc2917 · Oct 2, 2024 · 321c41a · 321c41a
2 parents eac8d65 + 490f4d1
commit 321c41a
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -10,12 +10,14 @@ Fargonaut is a package for post-processing and visualising outputs of [FARGO3D](
 
 >>> output = Output("/path/to/fargo3d/outputs/fargo")
 >>> gasdens50 = output.get_field("gasdens", 50)
->>> gasdens50.plot()
+>>> gasenergy50 = output.get_field("gasenergy", 50)
+>>> gaspressure50 = gasdens50 * gasdenergy50**2
+>>> gaspressure50.plot()
 ```
 
-![Gas surface density output 50](docs/images/fargo_gasdens50.png)
+![Gas pressure output 50](docs/images/fargo_gaspressure50.png)
 
-See the [documentation](https://dc2917.github.io/Fargonaut/user_docs.html) for installation instructions, example usage and the API reference.
+See the [documentation](https://dc2917.github.io/Fargonaut/index.html) for installation instructions, example usage and the API reference.
 
 ## Contributing to Fargonaut
 

diff --git a/docs/images/fargo_gasdens50.png b/docs/images/fargo_gasdens50.png
diff --git a/docs/images/fargo_gaspressure50.png b/docs/images/fargo_gaspressure50.png