Skip to content

DOC: Add setting descriptions for DE #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mberz wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

DOC: Add setting descriptions for DE #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions example_settings/de_setting.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"options": [
{
"name": "Simulation length",
"description": "Choose whether to set the simulation length based on the energy decay threshold (EDT) or by impulse response length.",
"id": "sim_len_type",
"type": "string",
"display": "radio",
Expand All @@ -15,6 +16,7 @@
},
{
"name": "Energy decay threshold",
"description": "The energy decay threshold for determining the simulation length. Once the energy decays below this threshold, the simulation will terminate.",

@SilvinWillemsen SilvinWillemsen Jul 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add at the start: "(Only used when the Simulation length is set to EDT.) The energy decay..." This way we're extra clear that whether this parameter has any effect is dependent on the Simulation length parameter.

"id": "edt",
"type": "integer",
"display": "text",
Expand All @@ -26,6 +28,7 @@
},
{
"name": "Impulse response length",
"description": "The maximum length of the impulse response to be simulated.",

@SilvinWillemsen SilvinWillemsen Jul 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

"id": "de_ir_length",
"type": "float",
"display": "text",
Expand All @@ -37,6 +40,7 @@
},
{
"name": "Speed of sound",
"description": "Speed of sound in air filling the room.",

@SilvinWillemsen SilvinWillemsen Jul 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Speed of sound propagation in the simulated geometry volume."?

"id": "de_c0",
"type": "float",
"display": "text",
Expand All @@ -48,6 +52,7 @@
},
{
"name": "Characteristic length (mesh)",
"description": "Characteristic length of the mesh used in the simulation.",

@SilvinWillemsen SilvinWillemsen Jul 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe at the end: "(i.e., the approximate distance between two mesh nodes.)"

"id": "de_lc",
"type": "float",
"display": "text",
Expand Down