Merge pull request #6 from openPMD/update_data

Close #4 and #5: no particle in 3D example & erroneous basePath

Author: ax3l

README.md

@@ -17,3 +17,8 @@ tar -zxvf example-2d.tar.gz
 tar -zxvf example-3d.tar.gz
 tar -zxvf example-thetaMode.tar.gz
 ```
+
+Note: The datasets were produced with the Particle-In-Cell code
+[Warp](https://bitbucket.org/berkeleylab/warp), from the scripts in
+`scripts/`. The resolution is intentionally very low, so as to produce
+data of manageable size.

example-2d.tar.gz

@@ -0,0 +1,46 @@
+"""
+This scripts runs Warp simulations which produce the openPMD data
+for this repository.
+
+Usage
+-----
+Simply type in a terminal:
+$ python main.py
+"""
+import os
+
+def produce_data( script_name, output_folder ):
+    """
+    Run a Warp simulation and compress the resulting directory of data
+
+    Parameters
+    ----------
+    script_name: string
+        The name of the Warp script to be run
+
+    output_folder: string
+        The name of the folder that will be created by Warp,
+        and which is to be compressed
+    """
+    # Run the simulation
+    command_line = 'python %s' %script_name
+    os.system( command_line )
+
+    # Compress the file
+    tar_name = '%s.tar.gz' %output_folder
+    if os.path.exists( tar_name ):
+        os.remove( tar_name )
+    command_line = 'tar -zcvf %s %s' %(tar_name, output_folder)
+    os.system( command_line )
+
+
+if __name__ == '__main__':
+
+    # Run the 2D simulation 
+    produce_data( 'warp_2d_script.py', 'example-2d' )
+
+    # Run the thetaMode simulation
+    produce_data( 'warp_thetaMode_script.py', 'example-thetaMode' )
+    
+    # Run the 3D simulation
+    produce_data( 'warp_3d_script.py', 'example-3d' )