Merge pull request #46 from uit-cosmo/1d_animation_readme

1d animation included in Readme

Author: sajidah-ahmed

.gitignore

@@ -139,7 +139,6 @@ dmypy.json
 .idea/
 
 # gifs
-1d_blobs.gif
 example.gif
 
 # png files

README.md

@@ -5,9 +5,10 @@
 # 2d_propagating_blobs
 Two dimensional model of advecting and dissipating blobs.
 
-The code has been deveoped originally to model profiles in the scrape-off layer of fusion experiments but it can be used to model any 2d system consisting of advecting pulses. An example is shown below:
-![Density evolution](readme_gifs/2d_blobs.gif ) 
+The code has been developed originally to model profiles in the scrape-off layer of fusion experiments but it can be used to model any 1d or 2d system consisting of advecting pulses. Examples for one and two dimensions are shown below:
+![Density evolution](readme_gifs/2d_blobs.gif)
 
+![Density evolution](readme_gifs/1d_blobs.gif)
 ## Installation
 The package is published to PyPI and can be installed with
 ```sh

blobmodel/plotting.py

@@ -10,7 +10,7 @@ def show_model(
     variable: str = "n",
     interval: int = 100,
     save: bool = False,
-    gif_name: str = "2d_blobs.gif",
+    gif_name: str = "blobs.gif",
     fps: int = 10,
 ) -> None:
     """Show animation of Model output.