Doc: Add etc documentation to contribution guidelines#9
Open
ahms5 wants to merge 1 commit into
Open
Conversation
mberz
requested changes
May 12, 2026
Contributor
mberz
left a comment
mberz
left a comment
There was a problem hiding this comment.
Thanks for creating this PR! I have added a couple of comments for improvement of the PR.
| json_output.write(json.dumps(result_container, indent=4)) | ||
|
|
||
|
|
||
| for ETC results assuming the etc of shape (n_receiver, n_fbands, n_times) and |
Contributor
There was a problem hiding this comment.
Suggested change
| for ETC results assuming the etc of shape (n_receiver, n_fbands, n_times) and | |
| for energy time curves - assuming the etc of shape (n_receiver, n_fbands, n_times) - and |
Comment on lines
+277
to
+287
| .. code-block:: python | ||
| for i_rec in range(n_receivers): | ||
| for i_frequency in range(n_bands): | ||
| result_container["results"][0]["responses"][i_rec]["receiverResults"].append( | ||
| { | ||
| "data": 10*np.log10(etc[i_rec, i_frequency]/1e-12).tolist(), | ||
| "t": times.tolist(), | ||
| "frequency": frequencies[i_frequency], | ||
| "type": "edc", | ||
| } | ||
| ) |
Contributor
There was a problem hiding this comment.
I was wondering if you could maybe also add an example which does not contain a loop so it's a bit easier to see the actual structure?
| Writing Results | ||
| ~~~~~~~~~~~~~~~ | ||
|
|
||
| For impulse responses, the sampling rate is fixed to 44.1kHz: |
Contributor
There was a problem hiding this comment.
It is actually also possible to specify a sampling rate in via the simulation settings.
The corresponding property, which can also be picked up by the backend is:
input_data["simulationSettings"]["sampling_rate"]
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add explaination how to add results on etc and impulse response to the doc.