Nathan Mannall
16bd1cc311
Add gprMax.cython to mocked imports
2025-07-28 13:11:21 +01:00
Nathan Mannall
4946861951
Add geometry objects read to Python API docs
2025-07-17 15:53:49 +01:00
Nathan Mannall
a3f0a64cb8
Update requirements for building docs
...
- Mock requirements that are not needed using 'autodoc_mock_imports'
- Add necessary requirements to requirements.txt
- These changes should mean the docs can be built without first
installing gprMax
2025-07-17 15:18:48 +01:00
Nathan Mannall
154370b8a0
Exclude generated docs from pre-commit hooks
2025-06-30 17:01:49 +01:00
Nathan Mannall
5122fe02d4
Add domain decomposition diagram to accerlator docs
2025-06-30 16:57:59 +01:00
Nathan Mannall
8bfbe63cb0
Clarify why FFTs cause fractal box decomposition limitations
2025-06-30 16:38:26 +01:00
Nathan Mannall
70497fe2a3
Add documentation about the reframe test suite
2025-06-30 16:30:48 +01:00
Nathan Mannall
2eac3b41dd
Add contributing guide to docs
2025-06-30 16:21:45 +01:00
Nathan Mannall
591dba9db8
Update HPC docs
2025-06-27 17:59:45 +01:00
Nathan Mannall
125492624d
Add note about VTKHDF change to docs
2025-06-25 13:47:26 +01:00
Nathan Mannall
5fe678fba3
Add guidance for using MPI domain decomposition
2025-06-25 13:27:46 +01:00
Nathan Mannall
7bbe924283
Add PML objects and fix import locations in API docs
...
- Correct import location for 'output' user objects
- Add documentation for PMLFormulation and PMLThickness userobjects
2025-06-19 15:21:20 +01:00
Nathan Mannall
df8a6bd956
Merge branch 'devel' into mpi
2025-06-19 15:21:19 +01:00
Nathan Mannall
024cf46adb
Fix broken reference links
2025-06-19 15:17:35 +01:00
Nathan Mannall
b390a83266
Fix logo not displaying on getting started page
2025-06-19 15:17:35 +01:00
Nathan Mannall
0d4397f8b8
Fix input API documentation
...
- Minor corrections to some code documentation
2025-06-19 15:17:35 +01:00
Nathan Mannall
8adb2781bf
Allow docs to be built without pip install of gprmax
2025-06-19 15:17:35 +01:00
Nathan Mannall
ff1929754a
By default build docs in a build directory
2025-06-19 15:17:35 +01:00
Craig Warren
29e2f15e02
Updated user_objects path for docs
2025-05-30 11:35:01 +01:00
Craig Warren
098ff7c7d0
Updated plotting examples to point to toolboxes.Plotting
2025-05-08 09:32:35 +01:00
Nathan Mannall
a32dcb030d
Merge branch 'devel-reframe' into mpi
2025-03-18 13:31:49 +00:00
Nathan Mannall
dd48a168c1
Add .gitignore to docs folder
2025-03-18 11:02:34 +00:00
Craig Warren
a248f6eca3
Grammar correction to discrete plane wave
2025-03-17 11:44:59 +00:00
Craig Warren
c157c0b8cd
Updated wording in discrete plane wave entry.
2025-03-17 11:44:02 +00:00
Craig Warren
ff08f68733
Doc and comment updates
2025-03-12 10:39:16 +00:00
Craig Warren
5876c99130
Further additions to DPW command
2025-03-11 09:05:03 +00:00
Craig Warren
3a198b0921
Initial docs for plane wave
2025-03-10 21:38:46 +00:00
nmannall
33e44ab882
Merge branch 'devel' into mpi
2024-04-17 12:30:28 +01:00
Craig Warren
324a66bcad
Added note on PML with fractal distributions
2024-04-15 15:57:08 +01:00
Craig Warren
5f9421ef42
Corrected excitation file switch to multiuse
2024-04-15 15:36:12 +01:00
nmannall
84b42062e6
Update documentation to reflect new taskfarm flag
2024-02-01 17:30:52 +00:00
saisuraj27
4710b5b5d7
Fixed pre-commit errors and updated black version.
2023-12-17 23:46:38 +05:30
craig-warren
df33382eb9
Clarified interp with excitatio file
2023-12-05 10:09:36 +00:00
Craig Warren
a6ca55b582
Tidied up waveform text
2023-11-06 20:45:30 +00:00
Craig Warren
c75a482b73
Added text on using antenna models with Python blocks, e.g. 'old way'
2023-09-18 14:19:10 +01:00
Sai-Suraj-27
caa9ed88ae
Ran pre-commit run --all-files to modify all the files correctly.
2023-09-08 16:06:59 +05:30
Craig Warren
f52e1d63cf
Reinstate PML CFS and formulation via hash cmds
2023-09-04 10:55:12 +01:00
Craig Warren
4dbc5c4d6a
Corrected path for plotting
2023-09-01 16:23:14 +01:00
craig-warren
246be121fd
Corrected some spelling
2023-07-07 12:15:18 +01:00
craig-warren
403924b327
Added note on voltage source with resistance and how conductivity in added
2023-07-06 16:44:04 +01:00
Sai-Suraj-27
f9dd7f2420
Added a pre-commit config file and reformatted all the files accordingly by using it.
2023-06-26 16:09:39 +05:30
Craig Warren
4b7753fbda
Added info for material range and list commands
2023-06-14 11:56:46 +01:00
Craig Warren
f24a9c4275
Updated syntax to reflect cmd line arg change
2023-06-13 16:13:59 +01:00
Craig Warren
b91156cf3a
Moved benchmarking images
2023-06-13 15:51:57 +01:00
Craig Warren
19804b1da5
Finished initial description of subgrid antenna example.
2023-06-12 16:30:23 +01:00
Craig Warren
f131d42d91
Adding descriptions to subgrid examples.
2023-06-12 15:52:28 +01:00
Craig Warren
ef9e65aa80
Images added to subgridding examples.
2023-06-12 15:22:09 +01:00
Craig Warren
95c96e01f6
Added to advanced examples on subgridding and PML
2023-05-05 16:02:48 +01:00
Craig Warren
c70a18c127
Subgridding docs and tidy
2023-05-05 13:12:23 +01:00
Craig Warren
5c6754a238
Finished docs for cone and ellipsoid
2023-05-05 11:22:59 +01:00