diff --git a/docs/source/include_user_libs_DebyeFit.rst b/docs/source/include_user_libs_DebyeFit.rst deleted file mode 100644 index d8646d37..00000000 --- a/docs/source/include_user_libs_DebyeFit.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../user_libs/DebyeFit/docs/README.rst \ No newline at end of file diff --git a/docs/source/include_user_libs_antenna_patterns.rst b/docs/source/include_user_libs_antenna_patterns.rst deleted file mode 100644 index d8f12a16..00000000 --- a/docs/source/include_user_libs_antenna_patterns.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../user_libs/AntennaPatterns/docs/README.rst \ No newline at end of file diff --git a/docs/source/include_user_libs_antennas.rst b/docs/source/include_user_libs_antennas.rst deleted file mode 100644 index bad7e0de..00000000 --- a/docs/source/include_user_libs_antennas.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../user_libs/antennas/docs/README.rst \ No newline at end of file diff --git a/docs/source/include_user_libs_austinman.rst b/docs/source/include_user_libs_austinman.rst deleted file mode 100644 index 74b5c2b5..00000000 --- a/docs/source/include_user_libs_austinman.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../user_libs/AustinManWoman/docs/README.rst \ No newline at end of file diff --git a/docs/source/include_user_libs_landmines.rst b/docs/source/include_user_libs_landmines.rst deleted file mode 100644 index dbf78f13..00000000 --- a/docs/source/include_user_libs_landmines.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../user_libs/landmines/docs/README.rst \ No newline at end of file diff --git a/docs/source/include_user_libs_materials.rst b/docs/source/include_user_libs_materials.rst deleted file mode 100644 index 5dafb801..00000000 --- a/docs/source/include_user_libs_materials.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../user_libs/materials/docs/README.rst \ No newline at end of file diff --git a/docs/source/include_user_libs_stltovoxel.rst b/docs/source/include_user_libs_stltovoxel.rst deleted file mode 100644 index 5131846d..00000000 --- a/docs/source/include_user_libs_stltovoxel.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../user_libs/stltovoxel/docs/README.rst \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index ea1ba866..93f53802 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,7 +6,7 @@ gprMax User Guide :maxdepth: 2 :caption: Introduction - include_readme + ../../README.rst features gprmodelling @@ -38,7 +38,13 @@ gprMax User Guide :maxdepth: 2 :caption: User libraries - ../../user_libs/antennas/docs/README.rst + ../../user_libs/GPRAntennaModels/docs/README.rst + ../../user_libs/AntennaPatterns/docs/README.rst + ../../user_libs/AustinMan/docs/README.rst + ../../user_libs/DebyeFit/docs/README.rst + ../../user_libs/LandmineModels/docs/README.rst + ../../user_libs/Materials/docs/README.rst + ../../user_libs/STLtoVoxel/docs/README.rst .. toctree:: :maxdepth: 2 diff --git a/user_libs/landmines/PMA_1x1x1.h5 b/user_libs/LandmineModels/PMA_1x1x1.h5 similarity index 100% rename from user_libs/landmines/PMA_1x1x1.h5 rename to user_libs/LandmineModels/PMA_1x1x1.h5 diff --git a/user_libs/landmines/PMA_2x2x2.h5 b/user_libs/LandmineModels/PMA_2x2x2.h5 similarity index 100% rename from user_libs/landmines/PMA_2x2x2.h5 rename to user_libs/LandmineModels/PMA_2x2x2.h5 diff --git a/user_libs/landmines/PMA_materials.txt b/user_libs/LandmineModels/PMA_materials.txt similarity index 100% rename from user_libs/landmines/PMA_materials.txt rename to user_libs/LandmineModels/PMA_materials.txt diff --git a/user_libs/landmines/PMN_1x1x1.h5 b/user_libs/LandmineModels/PMN_1x1x1.h5 similarity index 100% rename from user_libs/landmines/PMN_1x1x1.h5 rename to user_libs/LandmineModels/PMN_1x1x1.h5 diff --git a/user_libs/landmines/PMN_2x2x2.h5 b/user_libs/LandmineModels/PMN_2x2x2.h5 similarity index 100% rename from user_libs/landmines/PMN_2x2x2.h5 rename to user_libs/LandmineModels/PMN_2x2x2.h5 diff --git a/user_libs/landmines/PMN_materials.txt b/user_libs/LandmineModels/PMN_materials.txt similarity index 100% rename from user_libs/landmines/PMN_materials.txt rename to user_libs/LandmineModels/PMN_materials.txt diff --git a/user_libs/landmines/PMN_materials2.txt b/user_libs/LandmineModels/PMN_materials2.txt similarity index 100% rename from user_libs/landmines/PMN_materials2.txt rename to user_libs/LandmineModels/PMN_materials2.txt diff --git a/user_libs/landmines/TS50_1x1x1.h5 b/user_libs/LandmineModels/TS50_1x1x1.h5 similarity index 100% rename from user_libs/landmines/TS50_1x1x1.h5 rename to user_libs/LandmineModels/TS50_1x1x1.h5 diff --git a/user_libs/landmines/TS50_2x2x2.h5 b/user_libs/LandmineModels/TS50_2x2x2.h5 similarity index 100% rename from user_libs/landmines/TS50_2x2x2.h5 rename to user_libs/LandmineModels/TS50_2x2x2.h5 diff --git a/user_libs/landmines/TS50_materials.txt b/user_libs/LandmineModels/TS50_materials.txt similarity index 100% rename from user_libs/landmines/TS50_materials.txt rename to user_libs/LandmineModels/TS50_materials.txt diff --git a/user_libs/landmines/can_1x1x1.h5 b/user_libs/LandmineModels/can_1x1x1.h5 similarity index 100% rename from user_libs/landmines/can_1x1x1.h5 rename to user_libs/LandmineModels/can_1x1x1.h5 diff --git a/user_libs/landmines/can_2x2x2.h5 b/user_libs/LandmineModels/can_2x2x2.h5 similarity index 100% rename from user_libs/landmines/can_2x2x2.h5 rename to user_libs/LandmineModels/can_2x2x2.h5 diff --git a/user_libs/landmines/can_materials.txt b/user_libs/LandmineModels/can_materials.txt similarity index 100% rename from user_libs/landmines/can_materials.txt rename to user_libs/LandmineModels/can_materials.txt diff --git a/user_libs/landmines/docs/README.rst b/user_libs/LandmineModels/docs/README.rst similarity index 97% rename from user_libs/landmines/docs/README.rst rename to user_libs/LandmineModels/docs/README.rst index 1233fae5..4ce49c8f 100644 --- a/user_libs/landmines/docs/README.rst +++ b/user_libs/LandmineModels/docs/README.rst @@ -1,8 +1,8 @@ User libraries is a sub-package where useful Python modules contributed by users are stored. -********* -Landmines -********* +*************** +Landmine Models +*************** Information =========== @@ -71,7 +71,7 @@ The input file for inserting the PMN landmine, with the lower left corner 10mm f #domain: 0.136 0.176 0.070 #dx_dy_dz: 0.001 0.001 0.001 #time_window: 5e-9 - #geometry_objects_read: 0.010 0.010 0.010 ../user_libs/Landmines/PMN_1x1x1.h5 ../user_libs/Landmines/PMN_materials.txt + #geometry_objects_read: 0.010 0.010 0.010 ../user_libs/LandmineModels/PMN_1x1x1.h5 ../user_libs/LandmineModels/PMN_materials.txt #geometry_view: 0 0 0 0.136 0.176 0.070 0.001 0.001 0.001 landmine_PMN_fs n For further information on the ``#geometry_objects_read`` see the section on object contruction commands in the :ref:`Input commands section `. diff --git a/user_libs/landmines/docs/images/PMA.png b/user_libs/LandmineModels/docs/images/PMA.png similarity index 100% rename from user_libs/landmines/docs/images/PMA.png rename to user_libs/LandmineModels/docs/images/PMA.png diff --git a/user_libs/landmines/docs/images/PMN.png b/user_libs/LandmineModels/docs/images/PMN.png similarity index 100% rename from user_libs/landmines/docs/images/PMN.png rename to user_libs/LandmineModels/docs/images/PMN.png