up

pyphare/pyphare/pharein/simulation.py

@@ -736,13 +736,12 @@ class Simulation(object):
 
     **Setting time parameters:**
 
-        :Keyword Arguments:
-            * *final_time* (``float``)--
-              final simulation time. Use with time_step OR time_step_nbr
-            * *time_step* (``float``)--
-              simulation time step. Use with time_step_nbr OR final_time
-            * *time_step_nbr* (``int``) -- number of time step to perform.
-              Use with final_time OR time_step
+        * **final_time** (``float``)--
+          final simulation time. Use with time_step OR time_step_nbr
+        * **time_step** (``float``)--
+          simulation time step. Use with time_step_nbr OR final_time
+        * **time_step_nbr** (``int``) -- number of time step to perform.
+           Use with final_time OR time_step
 
 
         .. code-block:: python
@@ -782,18 +781,18 @@ class Simulation(object):
         The number of dimensions of the simulation is deduced from the length
         of these parameters.
 
-        * *dl* (``float``, ``tuple``)
-          grid spacing dx, (dx,dy) or (dx,dy,dz) in 1D, 2D or 3D.
+        * **dl** (``float``, ``tuple``) grid spacing dx, (dx,dy) or (dx,dy,dz) in 1D, 2D or 3D.
           A single float value in 2D or 3D are assumed equal for each dimension.
-          Use this parameter with either domain_size OR cells
-        * *domain_size* (``float`` or ``tuple``) --
+          Use this parameter with either `domain_size` OR `cells`
+
+        * **domain_size** (``float`` or ``tuple``)
           size of the physical domain Lx, (Lx,Ly), (Lx,Ly,Lz) in 1D, 2D or 3D
-          Single float is assumed equal for each direction.
-          Use this parameter with either cells or dl
-        * *cells* (``int`` or ``tuple``) --
+          Single float is assumed equal for each direction. Use this parameter with either `cells` or `dl`
+
+        * **cells** (``int`` or ``tuple``)
           number of cells nx or (nx, ny) or (nx, ny, nz) in 1, 2 and 3D.
           Single int is assumed equal for each direction
-          Use this parameter with either domain_size or dl
+          Use this parameter with either `domain_size` or `dl`
 
 
     For instance:
@@ -811,22 +810,15 @@ class Simulation(object):
 
     **Setting particle parameters:**
 
-        :Keyword Arguments:
-            * *interp_order* (``int``)--
-              1, 2 or 3 (default=1) particle b-spline order
-            * *particle_pusher* (``str``) --
-              algo to push particles (default = "modifiedBoris")
+        * **interp_order** (``int``), 1, 2 or 3 (default=1) particle b-spline order
+        * **particle_pusher** (``str``), algo to push particles (default = "modifiedBoris")
 
 
-    Setting diagnostics output parameters:
+    **Setting diagnostics output parameters:**
 
-        :Keyword Arguments:
-            * *path* (``str``)
-              path for outputs (default : './')
-            * *boundary_types* (``str`` or ``tuple``)
-              type of boundary conditions (default is "periodic" for each direction)
-            * *diag_export_format* (``str``)
-              format of the output diagnostics (default= "phareh5")
+        * **diag_options** (``dict``)
+            * **path** (``str``) path for outputs (default : './')
+            * **diag_export_format** (``str``) format of the output diagnostics (default= "phareh5")
 
 
     Misc:
@@ -835,6 +827,7 @@ class Simulation(object):
             * *strict* (``bool``)--
               turns warnings into errors (default False)
 
+        * **boundary_types** (``str`` or ``tuple``) type of boundary conditions (default is "periodic" for each direction)
 
 
     Adaptive Mesh Refinement (AMR) parameters