fixed typo and code style #2344
Merged
Conversation
This file contains 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
Thorsten please add the units
thorstenhater
requested changes
Jul 31, 2024
doc/python/decor.rst
Outdated
| decor = arbor.decor() | ||
| decor.set_property(rL=100, cm=0.1) | ||
| decor = A.decor() | ||
| decor.set_property(rL=100 [unit], cm=0.1[unit]) |
There was a problem hiding this comment.
Hi,
the units are explained here
Line 626 in 7d20a79
in the code. Note, however, that only the dimension needs to match, not the scale.
So, you could happily pass kOhm to any resistance-type argument and Arbor will
scale it properly.
There was a problem hiding this comment.
I did mean to say that you could find the units there, not that they aren't needed
" * Vm: initial membrane voltage [mV].\n"
" * cm: membrane capacitance [F/m²].\n"
" * rL: axial resistivity [Ω·cm].\n"
" * tempK: temperature [Kelvin].\n"
thorstenhater
requested changes
Aug 8, 2024
doc/python/decor.rst
Outdated
| # Specialize resistivity and capacitance on the axon, where | ||
| # axon is defined using a region expression. | ||
| decor.paint('(tag 2)', cm=0.05, rL=80) | ||
| decor.paint('(tag 2)', cm=0.05 * U.F/m², rL=80 * U.Ω·cm) |
doc/python/decor.rst
Outdated
| @@ -90,10 +92,10 @@ Cable cell decoration | |||
| .. code-block:: Python | |||
|
|
|||
| # Specialize resistivity on soma | |||
| decor.paint('"soma"', rL=100) | |||
| decor.paint('"soma"', rL=100 * U.Ω·cm) | |||
Co-authored-by: Thorsten Hater <[email protected]>
thorstenhater
approved these changes
Aug 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Thorsten please add the units