struphy 1.9.9__tar.gz → 2.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (313) hide show
  1. {struphy-1.9.9 → struphy-2.0.0}/LICENSE +1 -1
  2. {struphy-1.9.9/src/struphy.egg-info → struphy-2.0.0}/PKG-INFO +28 -8
  3. {struphy-1.9.9 → struphy-2.0.0}/README.md +25 -5
  4. {struphy-1.9.9 → struphy-2.0.0}/pyproject.toml +3 -2
  5. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/console/compile.py +23 -22
  6. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/console/example.py +8 -8
  7. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/console/main.py +132 -42
  8. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/console/pproc.py +12 -8
  9. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/console/profile.py +9 -6
  10. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/console/run.py +64 -57
  11. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/console/test.py +40 -27
  12. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/console/units.py +17 -9
  13. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/diagnostics/continuous_spectra.py +4 -1
  14. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/diagnostics/diagn_tools.py +57 -91
  15. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/dispersion_relations/analytic.py +119 -1
  16. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/mhd_axisymmetric_main.py +5 -2
  17. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/mhd_axisymmetric_pproc.py +4 -1
  18. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/TAE_tokamak.py +13 -7
  19. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/gc_orbits_tokamak.py +5 -2
  20. struphy-2.0.0/src/struphy/examples/linearextendedmhd.py +207 -0
  21. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/linearmhd.py +9 -10
  22. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/linearmhdvlasov_cc.py +7 -8
  23. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/linearmhdvlasov_pc.py +7 -8
  24. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/maxwell.py +7 -7
  25. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/orbits_tokamak.py +5 -2
  26. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/base.py +7 -37
  27. struphy-2.0.0/src/struphy/fields_background/mhd_equil/equils.py +1721 -0
  28. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/geometry/base.py +2 -2
  29. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/geometry/domains.py +4 -27
  30. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/geometry/map_eval.py +196 -0
  31. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/initial/eigenfunctions.py +4 -1
  32. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/examples/params_TAE_tokamak.yml +15 -12
  33. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/examples/params_gc_orbits_tokamak.yml +2 -2
  34. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/examples/params_hybridmhdvlasovcc.yml +2 -2
  35. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/examples/params_hybridmhdvlasovpc.yml +2 -2
  36. struphy-2.0.0/src/struphy/io/inp/examples/params_linearextendedmhd.yml +88 -0
  37. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/examples/params_linvlasovmaxwell_landau.yml +21 -25
  38. struphy-2.0.0/src/struphy/io/inp/examples/params_linvlasovmaxwell_weibel.yml +153 -0
  39. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/examples/params_orbits_tokamak.yml +1 -1
  40. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/parameters.yml +53 -35
  41. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/params_cc_linmhd_5d.yml +16 -13
  42. struphy-1.9.9/src/struphy/io/inp/examples/params_linvlasovmaxwell_weibel.yml → struphy-2.0.0/src/struphy/io/inp/tests/params_deltafvlasovmaxwell.yml +50 -44
  43. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/params_hybrid_fA.yml +10 -14
  44. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/params_hybridmhdvlasovcc.yml +2 -2
  45. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/params_hybridmhdvlasovcc_control.yml +8 -8
  46. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/params_hybridmhdvlasovcc_gvec.yml +3 -7
  47. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/params_hybridmhdvlasovpc.yml +2 -2
  48. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/params_linearmhd.yml +4 -5
  49. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/params_linearmhd_gvec.yml +18 -13
  50. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/params_linvlasovmaxwell.yml +24 -24
  51. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/params_maxwell_1.yml +1 -1
  52. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/params_maxwell_2.yml +1 -1
  53. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/strscl.yml +1 -1
  54. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/kinetic_background/analytical.py +61 -59
  55. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/kinetic_background/background_eval.py +2 -2
  56. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/kinetic_background/f0_kernels.py +10 -7
  57. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/kinetic_background/moments_kernels.py +109 -93
  58. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/models/base.py +13 -50
  59. struphy-2.0.0/src/struphy/models/fluid.py +484 -0
  60. struphy-2.0.0/src/struphy/models/hybrid.py +1036 -0
  61. struphy-2.0.0/src/struphy/models/kinetic.py +662 -0
  62. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/models/main.py +28 -14
  63. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/models/output_handling.py +13 -12
  64. struphy-2.0.0/src/struphy/models/toy.py +341 -0
  65. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/models/utilities.py +59 -42
  66. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/accum_kernels.py +203 -55
  67. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/mat_vec_filler.py +2200 -1998
  68. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/particles.py +51 -43
  69. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/pusher_kernels.py +181 -51
  70. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/pusher_utilities.py +54 -49
  71. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/utilities_kernels.py +4 -4
  72. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/polar/extraction_operators.py +3 -0
  73. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/post_processing/post_processing_tools.py +135 -89
  74. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/post_processing/pproc_struphy.py +77 -52
  75. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/post_processing/profile_struphy.py +1 -1
  76. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/propagators/propagators_coupling.py +345 -156
  77. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/propagators/propagators_fields.py +495 -24
  78. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/propagators/propagators_markers.py +61 -19
  79. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/basis_projection_ops.py +15 -0
  80. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/fields.py +7 -7
  81. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/mass.py +68 -0
  82. struphy-2.0.0/src/struphy/tests/tests_serial/test_mhd_equils.py +876 -0
  83. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_prop_solvers.py +1 -1
  84. {struphy-1.9.9 → struphy-2.0.0/src/struphy.egg-info}/PKG-INFO +28 -8
  85. {struphy-1.9.9 → struphy-2.0.0}/src/struphy.egg-info/SOURCES.txt +8 -2
  86. struphy-1.9.9/src/struphy/fields_background/mhd_equil/equils.py +0 -2097
  87. struphy-1.9.9/src/struphy/io/inp/examples/params_linvlasovmaxwell.yml +0 -169
  88. struphy-1.9.9/src/struphy/models/models.py +0 -1990
  89. {struphy-1.9.9 → struphy-2.0.0}/setup.cfg +0 -0
  90. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/__init__.py +0 -0
  91. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/b_splines/Bspline.py +0 -0
  92. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/b_splines/__init__.py +0 -0
  93. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/b_splines/bspline_evaluation_1d.py +0 -0
  94. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/b_splines/bspline_evaluation_2d.py +0 -0
  95. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/b_splines/bspline_evaluation_3d.py +0 -0
  96. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/b_splines/bsplines.py +0 -0
  97. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/b_splines/bsplines_kernels.py +0 -0
  98. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/b_splines/bsplines_kernels_particles.py +0 -0
  99. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/compile_struphy.mk +0 -0
  100. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/console/__init__.py +0 -0
  101. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/diagnostics/__init__.py +0 -0
  102. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/diagnostics/paraview/__init__.py +0 -0
  103. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/diagnostics/paraview/mesh_creator.py +0 -0
  104. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/diagnostics/paraview/vtk_writer.py +0 -0
  105. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/dispersion_relations/__init__.py +0 -0
  106. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/dispersion_relations/base.py +0 -0
  107. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/__init__.py +0 -0
  108. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/derivatives.py +0 -0
  109. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/kernels_2d.py +0 -0
  110. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/kernels_3d.py +0 -0
  111. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/kernels_projectors_global.py +0 -0
  112. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/kernels_projectors_global_mhd.py +0 -0
  113. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/MHD_eigenvalues_cylinder_1D.py +0 -0
  114. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/__init__.py +0 -0
  115. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/__init__.py +0 -0
  116. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/control_variate.py +0 -0
  117. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/kernels_control_variate.py +0 -0
  118. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/kinetic_extended/__init__.py +0 -0
  119. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/kinetic_extended/fB_massless_control_variate.py +0 -0
  120. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/kinetic_extended/fB_massless_kernels_control_variate.py +0 -0
  121. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/kinetic_extended/fnB_massless_control_variate.py +0 -0
  122. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/kinetic_extended/fnB_massless_cv_kernel_2.py +0 -0
  123. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/kinetic_extended/fnB_massless_kernels_control_variate.py +0 -0
  124. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/kinetic_extended/massless_control_variate.py +0 -0
  125. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/kinetic_extended/massless_cvker.py +0 -0
  126. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/control_variates/kinetic_extended/massless_kernels_control_variate.py +0 -0
  127. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/emw_operators.py +0 -0
  128. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/inner_products_1d.py +0 -0
  129. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/inner_products_2d.py +0 -0
  130. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/inner_products_3d.py +0 -0
  131. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/l2_error_1d.py +0 -0
  132. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/l2_error_2d.py +0 -0
  133. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/l2_error_3d.py +0 -0
  134. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/mass_matrices_3d_pre.py +0 -0
  135. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/massless_operators/__init__.py +0 -0
  136. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/massless_operators/fB_arrays.py +0 -0
  137. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/massless_operators/fB_bb_kernel.py +0 -0
  138. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/massless_operators/fB_bv_kernel.py +0 -0
  139. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/massless_operators/fB_massless_linear_operators.py +0 -0
  140. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/massless_operators/fB_vv_kernel.py +0 -0
  141. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/mhd_operators_MF.py +0 -0
  142. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/mhd_operators_MF_for_tests.py +0 -0
  143. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/projectors_local/__init__.py +0 -0
  144. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/projectors_local/pro_local/__init__.py +0 -0
  145. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/projectors_local/pro_local/kernels_projectors_local.py +0 -0
  146. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/projectors_local/pro_local/kernels_projectors_local_mhd.py +0 -0
  147. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/projectors_local/pro_local/mhd_operators_3d_local.py +0 -0
  148. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/projectors_local/pro_local/projectors_local.py +0 -0
  149. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/projectors_local/shape_pro_local/__init__.py +0 -0
  150. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/projectors_local/shape_pro_local/shape_L2_projector_kernel.py +0 -0
  151. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/projectors_local/shape_pro_local/shape_function_projectors_L2.py +0 -0
  152. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/projectors_local/shape_pro_local/shape_function_projectors_local.py +0 -0
  153. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/legacy/projectors_local/shape_pro_local/shape_local_projector_kernel.py +0 -0
  154. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/mass_matrices_1d.py +0 -0
  155. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/mass_matrices_2d.py +0 -0
  156. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/mass_matrices_3d.py +0 -0
  157. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/mhd_operators.py +0 -0
  158. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/mhd_operators_core.py +0 -0
  159. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/projectors_global.py +0 -0
  160. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/eigenvalue_solvers/spline_space.py +0 -0
  161. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/__init__.py +0 -0
  162. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/_draw_parallel.py +0 -0
  163. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/_mhd_eigenvalues_cylinder.py +0 -0
  164. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/_mhd_eigenvalues_slab.py +0 -0
  165. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/examples/_sendrecv.py +0 -0
  166. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/__init__.py +0 -0
  167. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/electric_equil/__init__.py +0 -0
  168. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/electric_equil/analytical.py +0 -0
  169. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/electric_equil/base.py +0 -0
  170. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/__init__.py +0 -0
  171. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/eqdsk/__init__.py +0 -0
  172. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/eqdsk/data/AUGNLED_g031213.00830.high +0 -0
  173. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/eqdsk/data/__init__.py +0 -0
  174. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/eqdsk/readeqdsk.py +0 -0
  175. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/gvec/__init__.py +0 -0
  176. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/gvec/ellipstell_v2/newBC_E1D6_M6N6/GVEC_ELLIPSTELL_V2_State_0000_00200000.dat +0 -0
  177. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/gvec/ellipstell_v2/newBC_E1D6_M6N6/parameter.ini +0 -0
  178. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/gvec/ellipstell_v2/newBC_E4D6_M6N6/GVEC_ELLIPSTELL_V2_State_0000_00200000.dat +0 -0
  179. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/gvec/ellipstell_v2/newBC_E4D6_M6N6/parameter.ini +0 -0
  180. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/gvec/ellipstell_v2/oldBC_E40D5M6N6/GVEC_ELLIPSTELL_V2_State_0000_00200000.dat +0 -0
  181. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/gvec/ellipstell_v2/oldBC_E40D5M6N6/parameter.ini +0 -0
  182. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/gvec/output/__init__.py +0 -0
  183. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/gvec/output/vtk/__init__.py +0 -0
  184. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/fields_background/mhd_equil/vmec/__init__.py +0 -0
  185. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/geometry/__init__.py +0 -0
  186. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/geometry/kernels.py +0 -0
  187. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/geometry/map_coef/__init__.py +0 -0
  188. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/geometry/mappings_fast.py +0 -0
  189. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/geometry/transform.py +0 -0
  190. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/geometry/utilities.py +0 -0
  191. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/initial/__init__.py +0 -0
  192. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/initial/analytic.py +0 -0
  193. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/initial/base.py +0 -0
  194. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/initial/initialize.py +0 -0
  195. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/initial/perturbations.py +0 -0
  196. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/__init__.py +0 -0
  197. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/batch/__init__.py +0 -0
  198. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/batch/batch_cobra.sh +0 -0
  199. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/batch/p_016.sh +0 -0
  200. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/batch/p_032.sh +0 -0
  201. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/batch/p_064.sh +0 -0
  202. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/batch/p_128.sh +0 -0
  203. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/batch/p_256.sh +0 -0
  204. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/batch/p_512.sh +0 -0
  205. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/__init__.py +0 -0
  206. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/examples/__init__.py +0 -0
  207. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/examples/params_linearmhd.yml +0 -0
  208. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/examples/params_maxwell.yml +0 -0
  209. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/__init__.py +0 -0
  210. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/wkscl_1.yml +0 -0
  211. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/wkscl_2.yml +0 -0
  212. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/wkscl_3.yml +0 -0
  213. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/wkscl_4.yml +0 -0
  214. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/wkscl_5.yml +0 -0
  215. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/wkscl_6.yml +0 -0
  216. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/wkscl_7.yml +0 -0
  217. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/inp/tests/wkscl_8.yml +0 -0
  218. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/io/out/__init__.py +0 -0
  219. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/kinetic_background/__init__.py +0 -0
  220. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/linear_algebra/__init__.py +0 -0
  221. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/linear_algebra/core.py +0 -0
  222. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/linear_algebra/iterative_solvers.py +0 -0
  223. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/linear_algebra/linalg_kron.py +0 -0
  224. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/linear_algebra/schur_solver.py +0 -0
  225. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/linear_algebra/stencil_dot_kernels.py +0 -0
  226. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/linear_algebra/stencil_transpose_kernels.py +0 -0
  227. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/models/__init__.py +0 -0
  228. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/__init__.py +0 -0
  229. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/filler_kernels.py +0 -0
  230. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/particles_to_grid.py +0 -0
  231. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/pusher.py +0 -0
  232. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/sampling.py +0 -0
  233. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/sobol_seq.py +0 -0
  234. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/pic/utilities.py +0 -0
  235. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/polar/__init__.py +0 -0
  236. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/polar/basic.py +0 -0
  237. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/polar/linear_operators.py +0 -0
  238. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/post_processing/__init__.py +0 -0
  239. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/post_processing/cprofile_analyser.py +0 -0
  240. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/propagators/__init__.py +0 -0
  241. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/propagators/base.py +0 -0
  242. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/propagators/solvers.py +0 -0
  243. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac-0.1-py3-none-any.whl +0 -0
  244. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/__init__.py +0 -0
  245. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/banded_to_stencil_kernels.py +0 -0
  246. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/basis_projection_kernels.py +0 -0
  247. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/linear_operators.py +0 -0
  248. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/mass_kernels.py +0 -0
  249. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/preconditioner.py +0 -0
  250. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/projectors.py +0 -0
  251. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/psydac_derham.py +0 -0
  252. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/quadrature_evaluation_kernels.py +0 -0
  253. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/utilities.py +0 -0
  254. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/psydac_api/utilities_kernels.py +0 -0
  255. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/__init__.py +0 -0
  256. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/__init__.py +0 -0
  257. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_accumulation.py +0 -0
  258. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_basis_operators.py +0 -0
  259. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_draw_parallel.py +0 -0
  260. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_eval_spline_mpi.py +0 -0
  261. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_iterative_solvers.py +0 -0
  262. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_mass_matrices.py +0 -0
  263. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_mat_vec_filler.py +0 -0
  264. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pic_legacy_files/__init__.py +0 -0
  265. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pic_legacy_files/accumulation.py +0 -0
  266. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pic_legacy_files/accumulation_kernels_3d.py +0 -0
  267. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pic_legacy_files/mappings_3d.py +0 -0
  268. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pic_legacy_files/mappings_3d_fast.py +0 -0
  269. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pic_legacy_files/pusher.py +0 -0
  270. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pic_legacy_files/pusher_pos.py +0 -0
  271. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pic_legacy_files/pusher_vel_2d.py +0 -0
  272. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pic_legacy_files/pusher_vel_3d.py +0 -0
  273. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pic_legacy_files/spline_evaluation_2d.py +0 -0
  274. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pic_legacy_files/spline_evaluation_3d.py +0 -0
  275. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_polar.py +0 -0
  276. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_psydac_basics.py +0 -0
  277. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_psydac_derham.py +0 -0
  278. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_pushers.py +0 -0
  279. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_stencil_dot_kernels.py +0 -0
  280. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/test_stencil_transpose_kernels.py +0 -0
  281. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_mpi/xx_test_send_ghost_regions.py +0 -0
  282. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/__init__.py +0 -0
  283. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_bsplines_kernels.py +0 -0
  284. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_domain.py +0 -0
  285. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_gvec_equil.py +0 -0
  286. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_legacy_mhd_projectors.py +0 -0
  287. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_legacy_polar_splines.py +0 -0
  288. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_numerical_MHD_equil.py +0 -0
  289. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_projectors_global.py +0 -0
  290. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_psydac_basis_operators.py +0 -0
  291. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_psydac_linear_operators.py +0 -0
  292. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_psydac_mapping.py +0 -0
  293. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/test_spline_space_1d.py +0 -0
  294. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_psydac_lin_ops.py +0 -0
  295. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_GVEC.py +0 -0
  296. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_codes.py +0 -0
  297. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_cprofiler.py +0 -0
  298. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_divB.py +0 -0
  299. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_filler_kernel.py +0 -0
  300. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_mappings.py +0 -0
  301. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_mat_vec_filler.py +0 -0
  302. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_mhd_equil.py +0 -0
  303. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_paraview.py +0 -0
  304. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_polar_splines_3D.py +0 -0
  305. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_preconditioner.py +0 -0
  306. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_psydac_lin_ops_loop.py +0 -0
  307. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_spline_evaluation.py +0 -0
  308. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_spline_interpolation.py +0 -0
  309. {struphy-1.9.9 → struphy-2.0.0}/src/struphy/tests/tests_serial/xx_test_template_gvec.py +0 -0
  310. {struphy-1.9.9 → struphy-2.0.0}/src/struphy.egg-info/dependency_links.txt +0 -0
  311. {struphy-1.9.9 → struphy-2.0.0}/src/struphy.egg-info/entry_points.txt +0 -0
  312. {struphy-1.9.9 → struphy-2.0.0}/src/struphy.egg-info/requires.txt +0 -0
  313. {struphy-1.9.9 → struphy-2.0.0}/src/struphy.egg-info/top_level.txt +0 -0
@@ -15,7 +15,7 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMA
15
15
  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
16
16
  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
17
17
 
18
- In addition, we ask you to cite the following reference inscientific publications which contain
18
+ In addition, we ask you to cite the following reference in scientific publications which contain
19
19
  results obtained with this software and developments:
20
20
 
21
21
  F. Holderied, S. Possanner, X. Wang,
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: struphy
3
- Version: 1.9.9
3
+ Version: 2.0.0
4
4
  Summary: Multi-model plasma physics package
5
5
  Author: Max Planck Institute for Plasma Physics
6
6
  Author-email: stefan.possanner@ipp.mpg.de, florian.holderied@ipp.mpg.de
@@ -21,7 +21,7 @@ License: Copyright 2019 (c) Struphy dev team | Max Planck Institute for Plasma P
21
21
  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22
22
  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
23
 
24
- In addition, we ask you to cite the following reference inscientific publications which contain
24
+ In addition, we ask you to cite the following reference in scientific publications which contain
25
25
  results obtained with this software and developments:
26
26
 
27
27
  F. Holderied, S. Possanner, X. Wang,
@@ -35,7 +35,7 @@ Project-URL: changelog, https://gitlab.mpcdf.mpg.de/struphy/struphy/-/blob/devel
35
35
  Project-URL: Bug Tracker, https://gitlab.mpcdf.mpg.de/struphy/struphy/-/issues
36
36
  Keywords: plasma physics, fusion, numerical modeling, partial differential equations, energetic particles
37
37
  Classifier: Programming Language :: Python :: 3
38
- Requires-Python: >=3.7
38
+ Requires-Python: <3.11,>=3.7
39
39
  Description-Content-Type: text/markdown
40
40
  License-File: LICENSE
41
41
 
@@ -48,9 +48,20 @@ in the division [NMPP (Numerical Methods for Plasma Physics)](https://www.ipp.mp
48
48
 
49
49
  ## What you can do with struphy
50
50
 
51
- * Solve a variety of [plasma physics PDEs](https://struphy.pages.mpcdf.de/struphy/sections/models.html) with fluid and/or kinetic components on [curved domains](https://struphy.pages.mpcdf.de/struphy/sections/domains.html)
52
- * [Post process](https://struphy.pages.mpcdf.de/struphy/sections/userguide.html#post-processing) data and generate `.vtk` files for 3d views
53
- * Add your own [model equations](https://struphy.pages.mpcdf.de/struphy/sections/developers.html#model-equations) or [physics feature](https://struphy.pages.mpcdf.de/struphy/sections/developers.html#how-to-add)
51
+ * Investigate plasma physics problems with multiple [models equations](https://struphy.pages.mpcdf.de/struphy/sections/models.html) containing fluid and/or kinetic components
52
+ * Simulate each model on [curved domains](https://struphy.pages.mpcdf.de/struphy/sections/domains.html)
53
+ * Load a variety of [MHD equilibira](https://struphy.pages.mpcdf.de/struphy/sections/mhd_equils.html) and [kinetic backgrounds](https://struphy.pages.mpcdf.de/struphy/sections/kinetic_backgrounds.html)
54
+ * Use [diagnostic tools](https://struphy.pages.mpcdf.de/struphy/sections/diagnostics.html) to visualize results
55
+ * Compare simulations to analytic [dispersion relations](https://struphy.pages.mpcdf.de/struphy/sections/diagnostics.html#module-struphy.dispersion_relations.analytic)
56
+ * Solve the [MHD eigenvalue problem](https://struphy.pages.mpcdf.de/struphy/index.html) in axisymmetric toroidal geometries
57
+ * [Improve Struphy](https://struphy.pages.mpcdf.de/struphy/sections/developers.html) by adding
58
+ * model equations
59
+ * domains (geometry)
60
+ * MHD equilibria
61
+ * kinetic backgrounds
62
+ * diagnostic tools
63
+ * dispersion relations
64
+ * other physics features (e.g. collision operators etc.)
54
65
 
55
66
  ## Algorithmic features
56
67
 
@@ -63,7 +74,16 @@ in the division [NMPP (Numerical Methods for Plasma Physics)](https://www.ipp.mp
63
74
 
64
75
  ## Installation
65
76
 
66
- * See the [struphy documentation](https://struphy.pages.mpcdf.de/struphy/index.html).
77
+ See the [struphy documentation](https://struphy.pages.mpcdf.de/struphy/index.html).
78
+
79
+ ## Tutorials
80
+
81
+ * [Turorial 01](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/blob/devel/notebooks/tutorial_01_units_run_main.ipynb): Learn about Struphy model's normalization (units), simulation parameters and the Struphy main execution file.
82
+
83
+ * [Tutorial 02](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/blob/devel/notebooks/tutorial_02_postproc_standard_plotting.ipynb): Learn about the data generated by Struphy simulations, data post processing and simple plotting
84
+ of field/fluid and kinetic variables.
85
+
86
+ * [Tutorial 03](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/blob/devel/notebooks/tutorial_03_plot_poloidal_planes.ipynb): Learn about plotting field/fluid variables in toroidal geometry.
67
87
 
68
88
  ## Key references
69
89
 
@@ -75,7 +95,7 @@ in the division [NMPP (Numerical Methods for Plasma Physics)](https://www.ipp.mp
75
95
 
76
96
  ## License
77
97
 
78
- Copyright 2022 (c) struphy dev team | CONTRIBUTING.md | Max Planck Institute for Plasma Physics
98
+ Copyright 2019 (c) Struphy dev team | Max Planck Institute for Plasma Physics
79
99
 
80
100
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
81
101
 
@@ -7,9 +7,20 @@ in the division [NMPP (Numerical Methods for Plasma Physics)](https://www.ipp.mp
7
7
 
8
8
  ## What you can do with struphy
9
9
 
10
- * Solve a variety of [plasma physics PDEs](https://struphy.pages.mpcdf.de/struphy/sections/models.html) with fluid and/or kinetic components on [curved domains](https://struphy.pages.mpcdf.de/struphy/sections/domains.html)
11
- * [Post process](https://struphy.pages.mpcdf.de/struphy/sections/userguide.html#post-processing) data and generate `.vtk` files for 3d views
12
- * Add your own [model equations](https://struphy.pages.mpcdf.de/struphy/sections/developers.html#model-equations) or [physics feature](https://struphy.pages.mpcdf.de/struphy/sections/developers.html#how-to-add)
10
+ * Investigate plasma physics problems with multiple [models equations](https://struphy.pages.mpcdf.de/struphy/sections/models.html) containing fluid and/or kinetic components
11
+ * Simulate each model on [curved domains](https://struphy.pages.mpcdf.de/struphy/sections/domains.html)
12
+ * Load a variety of [MHD equilibira](https://struphy.pages.mpcdf.de/struphy/sections/mhd_equils.html) and [kinetic backgrounds](https://struphy.pages.mpcdf.de/struphy/sections/kinetic_backgrounds.html)
13
+ * Use [diagnostic tools](https://struphy.pages.mpcdf.de/struphy/sections/diagnostics.html) to visualize results
14
+ * Compare simulations to analytic [dispersion relations](https://struphy.pages.mpcdf.de/struphy/sections/diagnostics.html#module-struphy.dispersion_relations.analytic)
15
+ * Solve the [MHD eigenvalue problem](https://struphy.pages.mpcdf.de/struphy/index.html) in axisymmetric toroidal geometries
16
+ * [Improve Struphy](https://struphy.pages.mpcdf.de/struphy/sections/developers.html) by adding
17
+ * model equations
18
+ * domains (geometry)
19
+ * MHD equilibria
20
+ * kinetic backgrounds
21
+ * diagnostic tools
22
+ * dispersion relations
23
+ * other physics features (e.g. collision operators etc.)
13
24
 
14
25
  ## Algorithmic features
15
26
 
@@ -22,7 +33,16 @@ in the division [NMPP (Numerical Methods for Plasma Physics)](https://www.ipp.mp
22
33
 
23
34
  ## Installation
24
35
 
25
- * See the [struphy documentation](https://struphy.pages.mpcdf.de/struphy/index.html).
36
+ See the [struphy documentation](https://struphy.pages.mpcdf.de/struphy/index.html).
37
+
38
+ ## Tutorials
39
+
40
+ * [Turorial 01](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/blob/devel/notebooks/tutorial_01_units_run_main.ipynb): Learn about Struphy model's normalization (units), simulation parameters and the Struphy main execution file.
41
+
42
+ * [Tutorial 02](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/blob/devel/notebooks/tutorial_02_postproc_standard_plotting.ipynb): Learn about the data generated by Struphy simulations, data post processing and simple plotting
43
+ of field/fluid and kinetic variables.
44
+
45
+ * [Tutorial 03](https://gitlab.mpcdf.mpg.de/struphy/struphy/-/blob/devel/notebooks/tutorial_03_plot_poloidal_planes.ipynb): Learn about plotting field/fluid variables in toroidal geometry.
26
46
 
27
47
  ## Key references
28
48
 
@@ -34,7 +54,7 @@ in the division [NMPP (Numerical Methods for Plasma Physics)](https://www.ipp.mp
34
54
 
35
55
  ## License
36
56
 
37
- Copyright 2022 (c) struphy dev team | CONTRIBUTING.md | Max Planck Institute for Plasma Physics
57
+ Copyright 2019 (c) Struphy dev team | Max Planck Institute for Plasma Physics
38
58
 
39
59
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
40
60
 
@@ -4,9 +4,9 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "struphy"
7
- version = "1.9.9"
7
+ version = "2.0.0"
8
8
  readme = "README.md"
9
- requires-python = ">=3.7"
9
+ requires-python = ">=3.7, <3.11"
10
10
  license = {file = "LICENSE"}
11
11
  authors = [
12
12
  { name = "Max Planck Institute for Plasma Physics"},
@@ -73,4 +73,5 @@ struphy = "struphy.console.main:struphy"
73
73
 
74
74
  struphy = ['compile_struphy.mk',
75
75
  'psydac-0.1-py3-none-any.whl',
76
+ 'io_path.txt',
76
77
  ]
@@ -1,67 +1,68 @@
1
1
  def struphy_compile(no_openmp=False, delete=False, verbose=False):
2
2
  """
3
3
  Compile Struphy kernels.
4
-
4
+
5
5
  Parameters
6
6
  ----------
7
7
  no_openmp : bool, optional
8
8
  Whether to compile kernels with (no_openmp=False) or without (no_openmp=True).
9
-
9
+
10
10
  delete : bool, optional
11
11
  If True, deletes generated Fortran and .so files.
12
-
12
+
13
13
  verbose : bool, optional
14
14
  Call pyccel in verbose mode.
15
15
  """
16
-
16
+
17
17
  import subprocess
18
18
  import struphy
19
19
  import os
20
20
 
21
21
  libpath = struphy.__path__[0]
22
-
22
+
23
23
  if delete:
24
-
24
+
25
25
  # (change dir not to be in source path)
26
26
  print('\nDeleting .f90 and .so files ...')
27
- subprocess.run(['make',
28
- 'clean',
27
+ subprocess.run(['make',
28
+ 'clean',
29
29
  '-f',
30
30
  'compile_struphy.mk',
31
31
  ], check=True, cwd=libpath)
32
32
  print('Done.')
33
-
33
+
34
34
  else:
35
-
35
+
36
36
  # struphy and psydac (change dir not to be in source path)
37
37
  flag_omp_pic = '--openmp'
38
38
  flag_omp_mhd = ''
39
39
  if no_openmp:
40
40
  flag_omp_pic = ''
41
-
41
+
42
42
  flag_verb = ''
43
43
  if verbose:
44
44
  flag_verb = '--verbose'
45
-
45
+
46
46
  try:
47
47
  import psydac.api
48
48
  except:
49
49
  print('\nInstalling Psydac ...')
50
- subprocess.run(['pip',
51
- 'install',
52
- os.path.join(libpath, 'psydac-0.1-py3-none-any.whl'),
50
+ subprocess.run(['pip',
51
+ 'install',
52
+ os.path.join(
53
+ libpath, 'psydac-0.1-py3-none-any.whl'),
53
54
  ], check=True)
54
- print('Done.')
55
-
55
+ print('Done.')
56
+
56
57
  # gvec_to_python (change dir not to be in source path)
57
- subprocess.run(['compile-gvec-tp'], check=True, cwd=libpath)
58
-
58
+ subprocess.run(['compile-gvec-tp'], check=True, cwd=libpath)
59
+
59
60
  print('\nCompiling Struphy and Psydac kernels ...')
60
- subprocess.run(['make',
61
- '-f',
61
+ subprocess.run(['make',
62
+ '-f',
62
63
  'compile_struphy.mk',
63
64
  'flags=' + flag_verb,
64
65
  'flags_openmp_pic=' + flag_omp_pic,
65
66
  'flags_openmp_mhd=' + flag_omp_mhd,
66
67
  ], check=True, cwd=libpath)
67
- print('Done.')
68
+ print('Done.')
@@ -1,30 +1,30 @@
1
1
  def struphy_example(case, diagnostics, mpi=1):
2
2
  """
3
3
  Run a Struphy example.
4
-
4
+
5
5
  Parameters
6
6
  ----------
7
7
  case : str
8
8
  Name of the example case to run.
9
-
9
+
10
10
  diagnostics : bool
11
11
  Wether to do diagnostics and plot only, if example has already been run before, and the output folder still exists.
12
-
12
+
13
13
  mpi : int
14
14
  Number of MPI processes used to run the example.
15
15
  """
16
-
16
+
17
17
  import subprocess
18
18
  import struphy
19
19
 
20
20
  libpath = struphy.__path__[0]
21
-
21
+
22
22
  command = ['python3',
23
23
  'examples/' + case + '.py',
24
24
  '--mpi',
25
25
  str(mpi)]
26
-
26
+
27
27
  if diagnostics:
28
28
  command += ['--diagnostics']
29
-
30
- subprocess.run(command, check=True, cwd=libpath)
29
+
30
+ subprocess.run(command, check=True, cwd=libpath)
@@ -4,14 +4,16 @@ import importlib.metadata
4
4
 
5
5
  __version__ = importlib.metadata.version("struphy")
6
6
 
7
+
7
8
  def struphy():
8
9
  '''
9
10
  Struphy main executable. Performs argument parsing and sub-command call.
10
11
  '''
11
12
 
12
- import os, inspect
13
+ import os
14
+ import inspect
13
15
  import argparse
14
- from struphy.models import models
16
+ from struphy.models import fluid, kinetic, hybrid, toy
15
17
  from struphy.console.compile import struphy_compile
16
18
  from struphy.console.run import struphy_run
17
19
  from struphy.console.units import struphy_units
@@ -19,7 +21,7 @@ def struphy():
19
21
  from struphy.console.pproc import struphy_pproc
20
22
  from struphy.console.example import struphy_example
21
23
  from struphy.console.test import struphy_test
22
-
24
+
23
25
  # create argument parser
24
26
  epilog_message = 'Run "struphy COMMAND --help" for more information on a command.\n\n'
25
27
  epilog_message += 'For more help on how to use Struphy, see https://struphy.pages.mpcdf.de/struphy/index.html'
@@ -37,15 +39,29 @@ def struphy():
37
39
  # path message
38
40
  import struphy
39
41
  libpath = struphy.__path__[0]
42
+
43
+ try:
44
+ with open(os.path.join(libpath, 'io_path.txt'), 'r') as f:
45
+ io_path = f.readlines()[0]
46
+ except FileNotFoundError:
47
+ # setting default io path
48
+ with open(os.path.join(libpath, 'io_path.txt'), 'w') as f:
49
+ f.write(libpath)
50
+ io_path = libpath
51
+
40
52
  path_message = f'Struphy installation path: {libpath}\n'
41
- path_message += f'default input: {libpath}/io/inp\n'
42
- path_message += f'default input: {libpath}/io/out\n'
43
- path_message += f'template batch scripts: {libpath}/io/batch'
53
+ path_message += f'default input: {io_path}/io/inp\n'
54
+ path_message += f'default output: {io_path}/io/out\n'
55
+ path_message += f'template batch scripts: {io_path}/io/batch'
44
56
 
45
57
  parser.add_argument('-v', '--version', action='version',
46
58
  version=version_message)
47
59
  parser.add_argument('-p', '--path', action='version',
48
60
  version=path_message, help='default installations and i/o paths')
61
+ parser.add_argument('--set-io',
62
+ type=str,
63
+ metavar='PATH',
64
+ help='set PATH to default I/O folder and copy templates there (type "." to use current working directory)',)
49
65
 
50
66
  # create sub-commands and save name of sub-command into variable "command"
51
67
  subparsers = parser.add_subparsers(title='available commands',
@@ -71,34 +87,72 @@ def struphy():
71
87
 
72
88
  # 2. "run" sub-command
73
89
  parser_run = subparsers.add_parser('run',
74
- formatter_class=lambda prog: argparse.HelpFormatter(
90
+ formatter_class=lambda prog: argparse.RawTextHelpFormatter(
75
91
  prog, max_help_position=30),
76
92
  help='run a Struphy model',
77
93
  description='Run a Struphy model.',
78
94
  epilog='For more info on Struphy models, visit https://struphy.pages.mpcdf.de/struphy/sections/models.html')
79
95
 
80
- list_models = []
81
- for name, obj in inspect.getmembers(models):
96
+ list_fluid = []
97
+ fluid_string = ''
98
+ for name, obj in inspect.getmembers(fluid):
99
+ if inspect.isclass(obj):
100
+ if name not in {'StruphyModel', }:
101
+ list_fluid += [name]
102
+ fluid_string += '"' + name + '"\n'
103
+
104
+ list_kinetic = []
105
+ kinetic_string = ''
106
+ for name, obj in inspect.getmembers(kinetic):
82
107
  if inspect.isclass(obj):
83
108
  if name not in {'StruphyModel', }:
84
- list_models += [name]
109
+ list_kinetic += [name]
110
+ kinetic_string += '"' + name + '"\n'
85
111
 
86
- models_string = ''
87
- for mod in list_models[:-1]:
88
- models_string += '"' + mod + '", '
112
+ list_hybrid = []
113
+ hybrid_string = ''
114
+ for name, obj in inspect.getmembers(hybrid):
115
+ if inspect.isclass(obj):
116
+ if name not in {'StruphyModel', }:
117
+ list_hybrid += [name]
118
+ hybrid_string += '"' + name + '"\n'
89
119
 
90
- models_string += 'or "' + list_models[-1] + '"'
120
+ list_toy = []
121
+ toy_string = ''
122
+ for name, obj in inspect.getmembers(toy):
123
+ if inspect.isclass(obj):
124
+ if name not in {'StruphyModel', }:
125
+ list_toy += [name]
126
+ toy_string += '"' + name + '"\n'
127
+
128
+ list_models = list_fluid + list_kinetic + list_hybrid + list_toy
129
+
130
+ # model message
131
+ model_message = 'which model to run, must be one of:\n'
132
+ model_message += '\nFluid models:\n'
133
+ model_message += '-------------\n'
134
+ model_message += fluid_string
135
+ model_message += '\nKinetic models:\n'
136
+ model_message += '---------------\n'
137
+ model_message += kinetic_string
138
+ model_message += '\nHybrid models:\n'
139
+ model_message += '--------------\n'
140
+ model_message += hybrid_string
141
+ model_message += '\nToy models:\n'
142
+ model_message += '-----------\n'
143
+ model_message += toy_string
144
+ # version_message += 'MIT license\n'
91
145
 
92
146
  parser_run.add_argument('model',
93
147
  type=str,
94
148
  choices=list_models,
95
149
  metavar='model',
96
- help='which model to run (must be one of ' + models_string + ')',)
150
+ help=model_message,)
97
151
 
98
152
  parser_run.add_argument('-i', '--input',
99
153
  type=str,
100
154
  metavar='FILE',
101
- help='parameter file (.yml) relative to <install_path>/struphy/io/inp/ (default=parameters.yml)',
155
+ help='parameter file (.yml) in current I/O path (default=parameters.yml)',
102
156
  default='parameters.yml',)
103
157
 
104
158
  parser_run.add_argument('--input-abs',
@@ -109,7 +163,7 @@ def struphy():
109
163
  parser_run.add_argument('-o', '--output',
110
164
  type=str,
111
165
  metavar='DIR',
112
- help='output directory relative to <install_path>/struphy/io/out/ (default=sim_1)',
166
+ help='output directory relative to current I/O path (default=sim_1)',
113
167
  default='sim_1',)
114
168
 
115
169
  parser_run.add_argument('--output-abs',
@@ -120,7 +174,7 @@ def struphy():
120
174
  parser_run.add_argument('-b', '--batch',
121
175
  type=str,
122
176
  metavar='FILE',
123
- help='batch script relative to <install_path>/struphy/io/batch/ ', )
177
+ help='batch script in current I/O path', )
124
178
 
125
179
  parser_run.add_argument('--batch-abs',
126
180
  type=str,
@@ -132,7 +186,7 @@ def struphy():
132
186
  metavar='N',
133
187
  help='maximum wall-clock time of program in minutes (default=300)',
134
188
  default=300,)
135
-
189
+
136
190
  parser_run.add_argument('-s', '--save-step',
137
191
  type=int,
138
192
  metavar='N',
@@ -156,7 +210,7 @@ def struphy():
156
210
  # 3. "units" sub-command
157
211
  parser_units = subparsers.add_parser(
158
212
  'units',
159
- formatter_class=lambda prog: argparse.HelpFormatter(
213
+ formatter_class=lambda prog: argparse.RawTextHelpFormatter(
160
214
  prog, max_help_position=30),
161
215
  help='show physical units of a Struphy model',
162
216
  description='Show physical units of a Struphy model.',
@@ -166,7 +220,7 @@ def struphy():
166
220
  type=str,
167
221
  choices=list_models,
168
222
  metavar='model',
169
- help='which model to look at (must be one of ' + models_string + ')',)
223
+ help=model_message,)
170
224
 
171
225
  parser_units.add_argument('-i', '--input',
172
226
  type=str,
@@ -190,21 +244,21 @@ def struphy():
190
244
  nargs='+',
191
245
  metavar='DIR',
192
246
  help='simulation ouput folders')
193
-
247
+
194
248
  parser_profile.add_argument('--replace',
195
- help='replace module names with class names for better info',
196
- action='store_true',)
197
-
249
+ help='replace module names with class names for better info',
250
+ action='store_true',)
251
+
198
252
  parser_profile.add_argument('--all',
199
- help='display the 50 most expensive function calls, without applying the predefined filter',
200
- action='store_true',)
201
-
253
+ help='display the 50 most expensive function calls, without applying the predefined filter',
254
+ action='store_true',)
255
+
202
256
  parser_profile.add_argument('--n-lines',
203
- type=int,
204
- metavar='N',
205
- help='plot the N most time consuming calls in profiling analysis (default=6)',
206
- default=6,)
207
-
257
+ type=int,
258
+ metavar='N',
259
+ help='plot the N most time consuming calls in profiling analysis (default=6)',
260
+ default=6,)
261
+
208
262
  parser_profile.add_argument('--print-callers',
209
263
  type=str,
210
264
  metavar='STR',
@@ -227,7 +281,7 @@ def struphy():
227
281
  type=str,
228
282
  metavar='DIR',
229
283
  help='simulation output folder to post-process, absolute path',)
230
-
284
+
231
285
  parser_pproc.add_argument('-s', '--step',
232
286
  type=int,
233
287
  metavar='N',
@@ -245,16 +299,16 @@ def struphy():
245
299
  'example',
246
300
  help='run a Struphy example',
247
301
  description='Run a complete Struphy example including prost-processing and plots.')
248
-
302
+
249
303
  files = os.listdir(os.path.join(libpath, 'examples'))
250
304
 
251
305
  list_examples = []
252
306
  for file in files:
253
307
  if file[-3:] == '.py' and file[0] != '_':
254
308
  list_examples += [file[:-3]]
255
-
309
+
256
310
  list_examples.sort()
257
-
311
+
258
312
  examples_string = ''
259
313
  for ex in list_examples[:-1]:
260
314
  examples_string += '"' + ex + '", '
@@ -271,7 +325,7 @@ def struphy():
271
325
  metavar='N',
272
326
  help='use "mpirun -n N" to launch the example in parallel (default=1)',
273
327
  default=1)
274
-
328
+
275
329
  parser_example.add_argument('-d', '--diagnostics',
276
330
  help='run diagnostics only, if output folder of example already exists',
277
331
  action='store_true')
@@ -299,10 +353,45 @@ def struphy():
299
353
  args = parser.parse_args()
300
354
 
301
355
  # if no arguments are passed, print help and exit
302
- if args.command is None:
356
+ if args.command is None and args.set_io is None:
303
357
  parser.print_help()
304
358
  exit()
305
359
 
360
+ # set default io path
361
+ if args.set_io:
362
+ if args.set_io == '.':
363
+ io_path = os.getcwd()
364
+ else:
365
+ io_path = args.set_io
366
+ try:
367
+ os.mkdir(io_path)
368
+ except:
369
+ pass
370
+
371
+ io_path = os.path.abspath(io_path)
372
+
373
+ with open(os.path.join(libpath, 'io_path.txt'), 'w') as f:
374
+ f.write(io_path)
375
+
376
+ io_dir = os.path.join(io_path, 'io/')
377
+ try:
378
+ os.mkdir(io_dir)
379
+ os.mkdir(os.path.join(io_dir, 'out/'))
380
+ except:
381
+ pass
382
+
383
+ from distutils.dir_util import copy_tree
384
+ copy_tree(os.path.join(libpath, 'io/inp/'),
385
+ os.path.join(io_dir, 'inp/'))
386
+ copy_tree(os.path.join(libpath, 'io/batch/'),
387
+ os.path.join(io_dir, 'batch/'))
388
+
389
+ print(f'New default I/O path has been set:')
390
+ import subprocess
391
+ subprocess.run(['struphy', '-p'])
392
+
393
+ exit()
394
+
306
395
  # handle argument dependencies in "sub-command"
307
396
  if args.command == 'test':
308
397
 
@@ -322,11 +411,12 @@ def struphy():
322
411
  # transform parser Namespace object to dictionary and remove "command" key
323
412
  kwargs = vars(args)
324
413
  kwargs.pop('command')
414
+ kwargs.pop('set_io')
325
415
 
326
416
  # start sub-command function with all parameters of that function
327
417
  func(**kwargs)
328
-
329
-
418
+
419
+
330
420
  class NoSubparsersMetavarFormatter(HelpFormatter):
331
421
  """
332
422
  Removes redundant COMMANDS printing in help message of argument parser.
@@ -362,4 +452,4 @@ class CustomFormatter(NoSubparsersMetavarFormatter, RawTextHelpFormatter):
362
452
  """
363
453
  Removes redundant COMMANDS printing in help message of argument parser and enables line breaks.
364
454
  """
365
- pass
455
+ pass
@@ -1,18 +1,18 @@
1
1
  def struphy_pproc(dirr, dir_abs=None, step=1, celldivide=1):
2
2
  """
3
3
  Post process data from finished Struphy runs.
4
-
4
+
5
5
  Parameters
6
6
  ----------
7
7
  dirr : str
8
8
  Path of simulation output folder relative to <struphy_path>/io/out.
9
-
9
+
10
10
  dir_abs : str
11
11
  Absolute path to the simulation output folder.
12
-
12
+
13
13
  step : int, optional
14
14
  Whether to do post-processing at every time step (step=1, default), every second time step (step=2), etc.
15
-
15
+
16
16
  celldivide : int, optional
17
17
  Number of grid point in each cell used to create vtk files (default=1).
18
18
  """
@@ -22,10 +22,13 @@ def struphy_pproc(dirr, dir_abs=None, step=1, celldivide=1):
22
22
 
23
23
  libpath = struphy.__path__[0]
24
24
 
25
+ with open(os.path.join(libpath, 'io_path.txt')) as f:
26
+ io_path = f.readlines()[0]
27
+
25
28
  # create absolute path
26
29
  if dir_abs is None:
27
- dir_abs = os.path.join(libpath, 'io/out', dirr)
28
-
30
+ dir_abs = os.path.join(io_path, 'io/out', dirr)
31
+
29
32
  # loop over output folders and call post-processing .py file
30
33
  subprocess.run(['python3',
31
34
  'post_processing/pproc_struphy.py',
@@ -33,5 +36,6 @@ def struphy_pproc(dirr, dir_abs=None, step=1, celldivide=1):
33
36
  '-s',
34
37
  str(step),
35
38
  '--celldivide',
36
- str(celldivide)],
37
- cwd=libpath)
39
+ str(celldivide)],
40
+ cwd=libpath,
41
+ check=True)