Merge pull request ComputationalRadiationPhysics#2331 from ax3l/topic-rmSimDefinesDir

(Re)Move simulation_defines/

Author: psychocoderHPC

USAGE.rst

@@ -48,7 +48,7 @@ Step-by-Step
 
 PIConGPU is controlled via two kinds of input sets: compile-time options and runtime options.
 
-Edit the :ref:`.param files<usage-params>` inside ``include/picongpu/simulation_defines/param/``.
+Edit the :ref:`.param files <usage-params>` inside ``include/picongpu/param/``.
 Initially and when options are changed, PIConGPU *requires a re-compile*.
 
 Now edit the :ref:`runtime (command line) arguments <usage-cfg>` in ``etc/picongpu/*.cfg``.

docs/source/usage/param.rst

@@ -5,7 +5,7 @@
 
 .. sectionauthor:: Axel Huebl
 
-Parameter files, ``*.param`` placed in ``include/picongpu/simulation_defines/param/`` are used to set all **compile-time options** for a PIConGPU simulation.
+Parameter files, ``*.param`` placed in ``include/picongpu/param/`` are used to set all **compile-time options** for a PIConGPU simulation.
 This includes most fundamental options such as numerical solvers, floating precision, memory usage due to attributes and super-cell based algorithms, density profiles, initial conditions etc.
 
 Editing

docs/source/usage/param/core.rst

@@ -8,63 +8,63 @@ dimension.param
 
 .. doxygenfile:: dimension.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/dimension.param
+   :path: include/picongpu/param/dimension.param
    :no-link:
 
 grid.param
 ^^^^^^^^^^
 
 .. doxygenfile:: grid.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/grid.param
+   :path: include/picongpu/param/grid.param
    :no-link:
 
 components.param
 ^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: components.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/components.param
+   :path: include/picongpu/param/components.param
    :no-link:
 
 fieldSolver.param
 ^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: fieldSolver.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/fieldSolver.param
+   :path: include/picongpu/param/fieldSolver.param
    :no-link:
 
 laser.param
 ^^^^^^^^^^^
 
 .. doxygenfile:: laser.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/laser.param
+   :path: include/picongpu/param/laser.param
    :no-link:
 
 pusher.param
 ^^^^^^^^^^^^
 
 .. doxygenfile:: pusher.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/pusher.param
+   :path: include/picongpu/param/pusher.param
    :no-link:
 
 density.param
 ^^^^^^^^^^^^^
 
 .. doxygenfile:: density.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/density.param
+   :path: include/picongpu/param/density.param
    :no-link:
 
 speciesAttributes.param
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: speciesAttributes.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/speciesAttributes.param
+   :path: include/picongpu/param/speciesAttributes.param
    :no-link:
 
 The following species attributes are defined by pmacc and always stored with a particle:
@@ -79,31 +79,31 @@ speciesConstants.param
 
 .. doxygenfile:: speciesConstants.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/speciesConstants.param
+   :path: include/picongpu/param/speciesConstants.param
    :no-link:
 
 species.param
 ^^^^^^^^^^^^^
 
 .. doxygenfile:: species.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/species.param
+   :path: include/picongpu/param/species.param
    :no-link:
 
 speciesDefinition.param
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: speciesDefinition.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/speciesDefinition.param
+   :path: include/picongpu/param/speciesDefinition.param
    :no-link:
 
 particle.param
 ^^^^^^^^^^^^^^
 
 .. doxygenfile:: particle.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/particle.param
+   :path: include/picongpu/param/particle.param
    :no-link:
 
 unit.param
@@ -127,5 +127,5 @@ speciesInitialization.param
 
 .. doxygenfile:: speciesInitialization.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/speciesInitialization.param
+   :path: include/picongpu/param/speciesInitialization.param
    :no-link:

docs/source/usage/param/extensions.rst

@@ -8,45 +8,45 @@ fieldBackground.param
 
 .. doxygenfile:: fieldBackground.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/fieldBackground.param
+   :path: include/picongpu/param/fieldBackground.param
    :no-link:
 
 bremsstrahlung.param
 ^^^^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: bremsstrahlung.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/bremsstrahlung.param
+   :path: include/picongpu/param/bremsstrahlung.param
    :no-link:
 
 synchrotronPhotons.param
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: synchrotronPhotons.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/synchrotronPhotons.param
+   :path: include/picongpu/param/synchrotronPhotons.param
    :no-link:
 
 ionizer.param
 ^^^^^^^^^^^^^
 
 .. doxygenfile:: ionizer.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/ionizer.param
+   :path: include/picongpu/param/ionizer.param
    :no-link:
 
 ionizationEnergies.param
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: ionizationEnergies.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/ionizationEnergies.param
+   :path: include/picongpu/param/ionizationEnergies.param
    :no-link:
 
 flylite.param
 ^^^^^^^^^^^^^
 
 .. doxygenfile:: flylite.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/flylite.param
+   :path: include/picongpu/param/flylite.param
    :no-link:

docs/source/usage/param/memory.rst

@@ -8,22 +8,22 @@ memory.param
 
 .. doxygenfile:: memory.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/memory.param
+   :path: include/picongpu/param/memory.param
    :no-link:
 
 precision.param
 ^^^^^^^^^^^^^^^
 
 .. doxygenfile:: precision.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/precision.param
+   :path: include/picongpu/param/precision.param
    :no-link:
 
 mallocMC.param
 ^^^^^^^^^^^^^^
 
 .. doxygenfile:: mallocMC.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/mallocMC.param
+   :path: include/picongpu/param/mallocMC.param
    :no-link:
 

docs/source/usage/param/misc.rst

@@ -8,22 +8,22 @@ starter.param
 
 .. doxygenfile:: starter.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/starter.param
+   :path: include/picongpu/param/starter.param
    :no-link:
 
 seed.param
 ^^^^^^^^^^
 
 .. doxygenfile:: seed.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/seed.param
+   :path: include/picongpu/param/seed.param
    :no-link:
 
 physicalConstants.param
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: physicalConstants.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/physicalConstants.param
+   :path: include/picongpu/param/physicalConstants.param
    :no-link:
 

docs/source/usage/param/plugins.rst

@@ -8,62 +8,62 @@ fileOutput.param
 
 .. doxygenfile:: fileOutput.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/fileOutput.param
+   :path: include/picongpu/param/fileOutput.param
    :no-link:
 
 isaac.param
 ^^^^^^^^^^^
 
 .. doxygenfile:: isaac.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/isaac.param
+   :path: include/picongpu/param/isaac.param
    :no-link:
 
 particleCalorimeter.param
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: particleCalorimeter.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/particleCalorimeter.param
+   :path: include/picongpu/param/particleCalorimeter.param
    :no-link:
 
 particleMerger.param
 ^^^^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: particleMerger.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/particleMerger.param
+   :path: include/picongpu/param/particleMerger.param
    :no-link:
 
 radiation.param
 ^^^^^^^^^^^^^^^
 
 .. doxygenfile:: radiation.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/radiation.param
+   :path: include/picongpu/param/radiation.param
    :no-link:
 
 radiationObserver.param
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: radiationObserver.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/radiationObserver.param
+   :path: include/picongpu/param/radiationObserver.param
    :no-link:
 
 visualization.param
 ^^^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: visualization.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/visualization.param
+   :path: include/picongpu/param/visualization.param
    :no-link:
 
 visColorScales.param
 ^^^^^^^^^^^^^^^^^^^^
 
 .. doxygenfile:: visColorScales.param
    :project: PIConGPU
-   :path: include/picongpu/simulation_defines/param/visColorScales.param
+   :path: include/picongpu/param/visColorScales.param
    :no-link:
 

include/picongpu/CMakeLists.txt

@@ -355,15 +355,15 @@ endif(ISAAC_FOUND)
 ################################################################################
 
 find_path(PIC_EXTENSION_PATH
-    NAMES include/simulation_defines/param/components.param
+    NAMES include/picongpu/param/components.param
     PATHS "${CMAKE_CURRENT_SOURCE_DIR}"
     DOC "search PATH to extension folder"
     NO_DEFAULT_PATH
     NO_CMAKE_ENVIRONMENT_PATH
     NO_CMAKE_SYSTEM_PATH
     )
 
-set(PIC_COPY_ON_INSTALL "include/picongpu/simulation_defines;etc/picongpu;lib"
+set(PIC_COPY_ON_INSTALL "include/picongpu;etc/picongpu;lib"
     CACHE LIST
     "Folders that are copied to installation path during install" )
 
@@ -472,7 +472,7 @@ install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/../../bin/" DESTINATION bin
 if( (NOT "${CMAKE_INSTALL_PREFIX}" STREQUAL "${PIC_EXTENSION_PATH}") OR
     (NOT EXISTS "${CMAKE_INSTALL_PREFIX}/include"))
 
-    #copy all important subfolders to install folder
+    # copy all important subfolders to install folder
     foreach(dir ${PIC_COPY_ON_INSTALL})
 
       #if source not exists than copy