From 4d5b39edaccbedcd3d9205cb5074019ab30b74b7 Mon Sep 17 00:00:00 2001 From: Newton Sander Date: Mon, 31 Jul 2023 14:14:55 +0200 Subject: [PATCH] Fixing docs --- docs/usage/defining_sources.md | 2 ++ docs/usage/loading_scenarios.md | 10 +++++----- docs/usage/running_simulation.md | 1 + 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/usage/defining_sources.md b/docs/usage/defining_sources.md index f810da6c..3a9088d1 100644 --- a/docs/usage/defining_sources.md +++ b/docs/usage/defining_sources.md @@ -6,6 +6,7 @@ import neurotechdevkit as ndk import numpy as np scenario = ndk.BUILTIN_SCENARIOS.SCENARIO_2_2D.value() +scenario.sources.clear() source = ndk.sources.FocusedSource2D( position=np.array([0.19, 0.07]), @@ -50,6 +51,7 @@ import neurotechdevkit as ndk import numpy as np scenario = ndk.BUILTIN_SCENARIOS.SCENARIO_2_2D.value() +scenario.sources.clear() source_position = np.array([0.19, 0.07]) source = ndk.sources.PlanarSource2D( diff --git a/docs/usage/loading_scenarios.md b/docs/usage/loading_scenarios.md index e4cb265f..7a68fb8c 100644 --- a/docs/usage/loading_scenarios.md +++ b/docs/usage/loading_scenarios.md @@ -14,11 +14,11 @@ scenario = ndk.BUILTIN_SCENARIOS.SCENARIO_2_2D.value() The existing scenario ids are: -- `scenario-0` (2D) - a simple quickstart toy scenario that enables users to dive in and experiment with their first simulation immediately. -- `scenario-1-3d` (3D) - a scenario containing a flat 3-layer bone covered by skin, with water above the skin and brain below the bone. This is based on benchmark 4 of [Jean-Francois Aubry, et al.](https://doi.org/10.1121/10.0013426). -- `scenario-2-3d` (3D) - a scenario containing a full skull and brain mesh immersed in water. This is based on benchmark 8 of [Jean-Francois Aubry, et al.](https://doi.org/10.1121/10.0013426). -- `scenario-1-2d` (2D) - a 2D version of scenario 1. -- `scenario-2-2d` (2D) - a 2D version of scenario 2. +- `SCENARIO_0` (2D) - a simple quickstart toy scenario that enables users to dive in and experiment with their first simulation immediately. +- `SCENARIO_1_3D` (3D) - a scenario containing a flat 3-layer bone covered by skin, with water above the skin and brain below the bone. This is based on benchmark 4 of [Jean-Francois Aubry, et al.](https://doi.org/10.1121/10.0013426). +- `SCENARIO_2_3D` (3D) - a scenario containing a full skull and brain mesh immersed in water. This is based on benchmark 8 of [Jean-Francois Aubry, et al.](https://doi.org/10.1121/10.0013426). +- `SCENARIO_1_2D` (2D) - a 2D version of scenario 1. +- `SCENARIO_2_2D` (2D) - a 2D version of scenario 2. All of these scenarios are immediately ready for visualization and simulation, with appropriate default parameters used where needed. diff --git a/docs/usage/running_simulation.md b/docs/usage/running_simulation.md index 27510423..5de1fe4b 100644 --- a/docs/usage/running_simulation.md +++ b/docs/usage/running_simulation.md @@ -6,6 +6,7 @@ Running a simulation takes just a single function call. import neurotechdevkit as ndk scenario = ndk.BUILTIN_SCENARIOS.SCENARIO_2_2D.value() +scenario.compile_problem(center_frequency=5e5) result = scenario.simulate_steady_state() result.render_steady_state_amplitudes() ```