Rename and clean up code

ChunYen-Chen · Jan 27, 2025 · cbcf7fc · cbcf7fc
1 parent 211ae00
commit cbcf7fc
Show file tree

Hide file tree

Showing 46 changed files with 47 additions and 52 deletions.
diff --git a/.github/workflows/update_test_problem_pages.yml b/.github/workflows/update_test_problem_pages.yml
@@ -5,7 +5,6 @@ on:
   push:
     paths:
       - 'example/test_problem/*/*/README.md'
-      # - 'example/test_problem/Template/README.md'
       - 'tool/wiki/sync_test_problem_pages.py'
 
 env:

diff --git a/...ed/Test-Problems:-AGORA_IsolatedGalaxy.md → ...ed/Test-Problems:-AGORA_IsolatedGalaxy.md b/...ed/Test-Problems:-AGORA_IsolatedGalaxy.md → ...ed/Test-Problems:-AGORA_IsolatedGalaxy.md
diff --git a/...em-related/Test-Problems:-AcousticWave.md → ...ms-related/Test-Problems:-AcousticWave.md b/...em-related/Test-Problems:-AcousticWave.md → ...ms-related/Test-Problems:-AcousticWave.md
diff --git a/...oblem-related/Test-Problems:-BlastWave.md → ...blems-related/Test-Problems:-BlastWave.md b/...oblem-related/Test-Problems:-BlastWave.md → ...blems-related/Test-Problems:-BlastWave.md
diff --git a/...t-Problem-related/Test-Problems:-Bondi.md → ...-Problems-related/Test-Problems:-Bondi.md b/...t-Problem-related/Test-Problems:-Bondi.md → ...-Problems-related/Test-Problems:-Bondi.md
diff --git a/...Problem-related/Test-Problems:-CDM_LSS.md → ...roblems-related/Test-Problems:-CDM_LSS.md b/...Problem-related/Test-Problems:-CDM_LSS.md → ...roblems-related/Test-Problems:-CDM_LSS.md
diff --git a/...est-Problem-related/Test-Problems:-CMZ.md → ...st-Problems-related/Test-Problems:-CMZ.md b/...est-Problem-related/Test-Problems:-CMZ.md → ...st-Problems-related/Test-Problems:-CMZ.md
diff --git a/...em-related/Test-Problems:-CR_Diffusion.md → ...ms-related/Test-Problems:-CR_Diffusion.md b/...em-related/Test-Problems:-CR_Diffusion.md → ...ms-related/Test-Problems:-CR_Diffusion.md
diff --git a/...em-related/Test-Problems:-CR_ShockTube.md → ...ms-related/Test-Problems:-CR_ShockTube.md b/...em-related/Test-Problems:-CR_ShockTube.md → ...ms-related/Test-Problems:-CR_ShockTube.md
diff --git a/...em-related/Test-Problems:-CR_SoundWave.md → ...ms-related/Test-Problems:-CR_SoundWave.md b/...em-related/Test-Problems:-CR_SoundWave.md → ...ms-related/Test-Problems:-CR_SoundWave.md
diff --git a/...Problem-related/Test-Problems:-Caustic.md → ...roblems-related/Test-Problems:-Caustic.md b/...Problem-related/Test-Problems:-Caustic.md → ...roblems-related/Test-Problems:-Caustic.md
diff --git a/...m-related/Test-Problems:-ClusterMerger.md → ...s-related/Test-Problems:-ClusterMerger.md b/...m-related/Test-Problems:-ClusterMerger.md → ...s-related/Test-Problems:-ClusterMerger.md
diff --git a/...lem-related/Test-Problems:-DiskHeating.md → ...ems-related/Test-Problems:-DiskHeating.md b/...lem-related/Test-Problems:-DiskHeating.md → ...ems-related/Test-Problems:-DiskHeating.md
diff --git a/...ted/Test-Problems:-EnergyPowerSpectrum.md → ...ted/Test-Problems:-EnergyPowerSpectrum.md b/...ted/Test-Problems:-EnergyPowerSpectrum.md → ...ted/Test-Problems:-EnergyPowerSpectrum.md
diff --git a/...-Problem-related/Test-Problems:-ExtPot.md → ...Problems-related/Test-Problems:-ExtPot.md b/...-Problem-related/Test-Problems:-ExtPot.md → ...Problems-related/Test-Problems:-ExtPot.md
diff --git a/...ated/Test-Problems:-GaussianWavePacket.md → ...ated/Test-Problems:-GaussianWavePacket.md b/...ated/Test-Problems:-GaussianWavePacket.md → ...ated/Test-Problems:-GaussianWavePacket.md
diff --git a/...Problem-related/Test-Problems:-Gravity.md → ...roblems-related/Test-Problems:-Gravity.md b/...Problem-related/Test-Problems:-Gravity.md → ...roblems-related/Test-Problems:-Gravity.md
diff --git a/...blem-related/Test-Problems:-HaloMerger.md → ...lems-related/Test-Problems:-HaloMerger.md b/...blem-related/Test-Problems:-HaloMerger.md → ...lems-related/Test-Problems:-HaloMerger.md
diff --git a/...em-related/Test-Problems:-IsolatedHalo.md → ...ms-related/Test-Problems:-IsolatedHalo.md b/...em-related/Test-Problems:-IsolatedHalo.md → ...ms-related/Test-Problems:-IsolatedHalo.md
diff --git a/...elated/Test-Problems:-JeansInstability.md → ...elated/Test-Problems:-JeansInstability.md b/...elated/Test-Problems:-JeansInstability.md → ...elated/Test-Problems:-JeansInstability.md
diff --git a/...est-Problems:-JeansInstabilityComoving.md → ...est-Problems:-JeansInstabilityComoving.md b/...est-Problems:-JeansInstabilityComoving.md → ...est-Problems:-JeansInstabilityComoving.md
diff --git a/...est-Problem-related/Test-Problems:-Jet.md → ...st-Problems-related/Test-Problems:-Jet.md b/...est-Problem-related/Test-Problems:-Jet.md → ...st-Problems-related/Test-Problems:-Jet.md
diff --git a/...blem-related/Test-Problems:-JetICMWall.md → ...lems-related/Test-Problems:-JetICMWall.md b/...blem-related/Test-Problems:-JetICMWall.md → ...lems-related/Test-Problems:-JetICMWall.md
diff --git a/...t-Problems:-KelvinHelmholtzInstability.md → ...t-Problems:-KelvinHelmholtzInstability.md b/...t-Problems:-KelvinHelmholtzInstability.md → ...t-Problems:-KelvinHelmholtzInstability.md
diff --git a/...est-Problem-related/Test-Problems:-LSS.md → ...st-Problems-related/Test-Problems:-LSS.md b/...est-Problem-related/Test-Problems:-LSS.md → ...st-Problems-related/Test-Problems:-LSS.md
diff --git a/...blem-related/Test-Problems:-LSS_Hybrid.md → ...lems-related/Test-Problems:-LSS_Hybrid.md b/...blem-related/Test-Problems:-LSS_Hybrid.md → ...lems-related/Test-Problems:-LSS_Hybrid.md
diff --git a/...Problem-related/Test-Problems:-MHD_ABC.md → ...roblems-related/Test-Problems:-MHD_ABC.md b/...Problem-related/Test-Problems:-MHD_ABC.md → ...roblems-related/Test-Problems:-MHD_ABC.md
diff --git a/...-related/Test-Problems:-MHD_LinearWave.md → ...-related/Test-Problems:-MHD_LinearWave.md b/...-related/Test-Problems:-MHD_LinearWave.md → ...-related/Test-Problems:-MHD_LinearWave.md
diff --git a/...ed/Test-Problems:-MHD_OrszagTangVortex.md → ...ed/Test-Problems:-MHD_OrszagTangVortex.md b/...ed/Test-Problems:-MHD_OrszagTangVortex.md → ...ed/Test-Problems:-MHD_OrszagTangVortex.md
diff --git a/...d/Test-Problems:-ParticleEquilibriumIC.md → ...d/Test-Problems:-ParticleEquilibriumIC.md b/...d/Test-Problems:-ParticleEquilibriumIC.md → ...d/Test-Problems:-ParticleEquilibriumIC.md
diff --git a/...em-related/Test-Problems:-ParticleTest.md → ...ms-related/Test-Problems:-ParticleTest.md b/...em-related/Test-Problems:-ParticleTest.md → ...ms-related/Test-Problems:-ParticleTest.md
diff --git a/...em-related/Test-Problems:-Perturbation.md → ...ms-related/Test-Problems:-Perturbation.md b/...em-related/Test-Problems:-Perturbation.md → ...ms-related/Test-Problems:-Perturbation.md
diff --git a/...oblem-related/Test-Problems:-PlaneWave.md → ...blems-related/Test-Problems:-PlaneWave.md b/...oblem-related/Test-Problems:-PlaneWave.md → ...blems-related/Test-Problems:-PlaneWave.md
diff --git a/...Problem-related/Test-Problems:-Plummer.md → ...roblems-related/Test-Problems:-Plummer.md b/...Problem-related/Test-Problems:-Plummer.md → ...roblems-related/Test-Problems:-Plummer.md
diff --git a/...ted/Test-Problems:-RestrictionMismatch.md → ...ted/Test-Problems:-RestrictionMismatch.md b/...ted/Test-Problems:-RestrictionMismatch.md → ...ted/Test-Problems:-RestrictionMismatch.md
diff --git a/...Problem-related/Test-Problems:-Riemann.md → ...roblems-related/Test-Problems:-Riemann.md b/...Problem-related/Test-Problems:-Riemann.md → ...roblems-related/Test-Problems:-Riemann.md
diff --git a/...related/Test-Problems:-SelfSimilarHalo.md → ...related/Test-Problems:-SelfSimilarHalo.md b/...related/Test-Problems:-SelfSimilarHalo.md → ...related/Test-Problems:-SelfSimilarHalo.md
diff --git a/...Problem-related/Test-Problems:-Soliton.md → ...roblems-related/Test-Problems:-Soliton.md b/...Problem-related/Test-Problems:-Soliton.md → ...roblems-related/Test-Problems:-Soliton.md
diff --git a/...lated/Test-Problems:-SphericalCollapse.md → ...lated/Test-Problems:-SphericalCollapse.md b/...lated/Test-Problems:-SphericalCollapse.md → ...lated/Test-Problems:-SphericalCollapse.md
diff --git a/...elated/Test-Problems:-VortexPairLinear.md → ...elated/Test-Problems:-VortexPairLinear.md b/...elated/Test-Problems:-VortexPairLinear.md → ...elated/Test-Problems:-VortexPairLinear.md
diff --git a/...Test-Problems:-VortexPairLinear_Hybrid.md → ...Test-Problems:-VortexPairLinear_Hybrid.md b/...Test-Problems:-VortexPairLinear_Hybrid.md → ...Test-Problems:-VortexPairLinear_Hybrid.md
diff --git a/...ated/Test-Problems:-VortexPairRotating.md → ...ated/Test-Problems:-VortexPairRotating.md b/...ated/Test-Problems:-VortexPairRotating.md → ...ated/Test-Problems:-VortexPairRotating.md
diff --git a/...st-Problems:-VortexPairRotating_Hybrid.md → ...st-Problems:-VortexPairRotating_Hybrid.md b/...st-Problems:-VortexPairRotating_Hybrid.md → ...st-Problems:-VortexPairRotating_Hybrid.md
diff --git a/...oblem-related/Test-Problems:-Zeldovich.md → ...blems-related/Test-Problems:-Zeldovich.md b/...oblem-related/Test-Problems:-Zeldovich.md → ...blems-related/Test-Problems:-Zeldovich.md
diff --git a/doc/wiki/Test-Problems.md b/doc/wiki/Test-Problems.md
@@ -1,99 +1,99 @@
 > [!CAUTION]
-> Please do not edit this file(page) manually since the workflow will overwrite your changes.
+> Please do not edit this file (page) manually since the workflow will overwrite your changes.
 >
-> This file(page) is automatically generated by the workflow `Update test problem wiki page` using the script `tool/wiki/sync_test_problem_pages.py`.
+> This file (page) is automatically generated by the workflow `Update test problem wiki page` using the script `tool/wiki/sync_test_problem_pages.py`.
 >
 > The workflow is triggered by push changes to any of `example/test_problem/*/*/README.md` and `tool/wiki/sync_test_problem_pages.py`.
 
 Before going to the test problem, please check out the demos in [[Quick Start]].
 
 # ELBDM tests
-[[ DiskHeating \| Test-Problems:-DiskHeating ]]
+[[DiskHeating | Test-Problems:-DiskHeating]]
 
-[[ ExtPot \| Test-Problems:-ExtPot ]]
+[[ExtPot | Test-Problems:-ExtPot]]
 
-[[ GaussianWavePacket \| Test-Problems:-GaussianWavePacket ]]
+[[GaussianWavePacket | Test-Problems:-GaussianWavePacket]]
 
-[[ HaloMerger \| Test-Problems:-HaloMerger ]]
+[[HaloMerger | Test-Problems:-HaloMerger]]
 
-[[ IsolatedHalo \| Test-Problems:-IsolatedHalo ]]
+[[IsolatedHalo | Test-Problems:-IsolatedHalo]]
 
-[[ JeansInstabilityComoving \| Test-Problems:-JeansInstabilityComoving ]]
+[[JeansInstabilityComoving | Test-Problems:-JeansInstabilityComoving]]
 
-[[ LSS \| Test-Problems:-LSS ]]
+[[LSS | Test-Problems:-LSS]]
 
-[[ LSS_Hybrid \| Test-Problems:-LSS_Hybrid ]]
+[[LSS_Hybrid | Test-Problems:-LSS_Hybrid]]
 
-[[ Perturbation \| Test-Problems:-Perturbation ]]
+[[Perturbation | Test-Problems:-Perturbation]]
 
-[[ PlaneWave \| Test-Problems:-PlaneWave ]]
+[[PlaneWave | Test-Problems:-PlaneWave]]
 
-[[ RestrictionMismatch \| Test-Problems:-RestrictionMismatch ]]
+[[RestrictionMismatch | Test-Problems:-RestrictionMismatch]]
 
-[[ SelfSimilarHalo \| Test-Problems:-SelfSimilarHalo ]]
+[[SelfSimilarHalo | Test-Problems:-SelfSimilarHalo]]
 
-[[ Soliton \| Test-Problems:-Soliton ]]
+[[Soliton | Test-Problems:-Soliton]]
 
-[[ VortexPairLinear \| Test-Problems:-VortexPairLinear ]]
+[[VortexPairLinear | Test-Problems:-VortexPairLinear]]
 
-[[ VortexPairLinear_Hybrid \| Test-Problems:-VortexPairLinear_Hybrid ]]
+[[VortexPairLinear_Hybrid | Test-Problems:-VortexPairLinear_Hybrid]]
 
-[[ VortexPairRotating \| Test-Problems:-VortexPairRotating ]]
+[[VortexPairRotating | Test-Problems:-VortexPairRotating]]
 
-[[ VortexPairRotating_Hybrid \| Test-Problems:-VortexPairRotating_Hybrid ]]
+[[VortexPairRotating_Hybrid | Test-Problems:-VortexPairRotating_Hybrid]]
 
 
 # Hydro tests
-[[ AGORA_IsolatedGalaxy \| Test-Problems:-AGORA_IsolatedGalaxy ]]
+[[AGORA_IsolatedGalaxy | Test-Problems:-AGORA_IsolatedGalaxy]]
 
-[[ AcousticWave \| Test-Problems:-AcousticWave ]]
+[[AcousticWave | Test-Problems:-AcousticWave]]
 
-[[ BlastWave \| Test-Problems:-BlastWave ]]
+[[BlastWave | Test-Problems:-BlastWave]]
 
-[[ Bondi \| Test-Problems:-Bondi ]]
+[[Bondi | Test-Problems:-Bondi]]
 
-[[ CDM_LSS \| Test-Problems:-CDM_LSS ]]
+[[CDM_LSS | Test-Problems:-CDM_LSS]]
 
-[[ CMZ \| Test-Problems:-CMZ ]]
+[[CMZ | Test-Problems:-CMZ]]
 
-[[ CR_Diffusion \| Test-Problems:-CR_Diffusion ]]
+[[CR_Diffusion | Test-Problems:-CR_Diffusion]]
 
-[[ CR_ShockTube \| Test-Problems:-CR_ShockTube ]]
+[[CR_ShockTube | Test-Problems:-CR_ShockTube]]
 
-[[ CR_SoundWave \| Test-Problems:-CR_SoundWave ]]
+[[CR_SoundWave | Test-Problems:-CR_SoundWave]]
 
-[[ Caustic \| Test-Problems:-Caustic ]]
+[[Caustic | Test-Problems:-Caustic]]
 
-[[ ClusterMerger \| Test-Problems:-ClusterMerger ]]
+[[ClusterMerger | Test-Problems:-ClusterMerger]]
 
-[[ EnergyPowerSpectrum \| Test-Problems:-EnergyPowerSpectrum ]]
+[[EnergyPowerSpectrum | Test-Problems:-EnergyPowerSpectrum]]
 
-[[ Gravity \| Test-Problems:-Gravity ]]
+[[Gravity | Test-Problems:-Gravity]]
 
-[[ JeansInstability \| Test-Problems:-JeansInstability ]]
+[[JeansInstability | Test-Problems:-JeansInstability]]
 
-[[ Jet \| Test-Problems:-Jet ]]
+[[Jet | Test-Problems:-Jet]]
 
-[[ JetICMWall \| Test-Problems:-JetICMWall ]]
+[[JetICMWall | Test-Problems:-JetICMWall]]
 
-[[ KelvinHelmholtzInstability \| Test-Problems:-KelvinHelmholtzInstability ]]
+[[KelvinHelmholtzInstability | Test-Problems:-KelvinHelmholtzInstability]]
 
-[[ MHD_ABC \| Test-Problems:-MHD_ABC ]]
+[[MHD_ABC | Test-Problems:-MHD_ABC]]
 
-[[ MHD_LinearWave \| Test-Problems:-MHD_LinearWave ]]
+[[MHD_LinearWave | Test-Problems:-MHD_LinearWave]]
 
-[[ MHD_OrszagTangVortex \| Test-Problems:-MHD_OrszagTangVortex ]]
+[[MHD_OrszagTangVortex | Test-Problems:-MHD_OrszagTangVortex]]
 
-[[ ParticleEquilibriumIC \| Test-Problems:-ParticleEquilibriumIC ]]
+[[ParticleEquilibriumIC | Test-Problems:-ParticleEquilibriumIC]]
 
-[[ ParticleTest \| Test-Problems:-ParticleTest ]]
+[[ParticleTest | Test-Problems:-ParticleTest]]
 
-[[ Plummer \| Test-Problems:-Plummer ]]
+[[Plummer | Test-Problems:-Plummer]]
 
-[[ Riemann \| Test-Problems:-Riemann ]]
+[[Riemann | Test-Problems:-Riemann]]
 
-[[ SphericalCollapse \| Test-Problems:-SphericalCollapse ]]
+[[SphericalCollapse | Test-Problems:-SphericalCollapse]]
 
-[[ Zeldovich \| Test-Problems:-Zeldovich ]]
+[[Zeldovich | Test-Problems:-Zeldovich]]
 
 
diff --git a/tool/wiki/sync_test_problem_pages.py b/tool/wiki/sync_test_problem_pages.py
@@ -9,7 +9,7 @@
 # Global constants
 #====================================================================================================
 EXAMPLE_DIR = "../../example/test_problem/"
-WIKI_DIR    = "../../doc/wiki/Test-Problem-related/"
+WIKI_DIR    = "../../doc/wiki/Test-Problems-related/"
 OUT_MD      = "../../doc/wiki/Test-Problems.md"
 
 
@@ -71,8 +71,6 @@ def CopyAndAddMsg( filename, target ):
 
 # output markdown file with new test problem
 with open( OUT_MD, 'w' ) as f:
-    param_str_format = '| %-100s | %15s | %15s | %15s | %s |\n'
-
     f.write( '> [!CAUTION]\n' )
     f.write( '> Please do not edit this file (page) manually since the workflow will overwrite your changes.\n' )
     f.write( '>\n' )
@@ -83,12 +81,10 @@ def CopyAndAddMsg( filename, target ):
     f.write( 'Before going to the test problem, please check out the demos in [[Quick Start]].\n' )
     f.write( '\n' )
 
-    #f.write( "[[ %s \\| %s ]]\n"%("Template", "Test-Problems:-Template") )
-    #f.write( "\n" )
     for model, p in ALL_PATHS.items():
         if model == "Template": continue
         f.write( "# %s tests\n"%model )
         for test in sorted(list(ALL_PATHS[model].keys())):
-            f.write( "[[ %s \\| %s ]]\n"%(test, "Test-Problems:-%s"%test) )
+            f.write( "[[%s | %s]]\n"%(test, "Test-Problems:-%s"%test) )
             f.write( "\n" )
         f.write( "\n" )
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,6 @@ on: @@
       push:
         paths:
           - 'example/test_problem/*/*/README.md'
-          # - 'example/test_problem/Template/README.md'
           - 'tool/wiki/sync_test_problem_pages.py'
     env:
@@ Expand Down @@