Skip to content

Commit

Permalink
Merge pull request #185 from AurelienJaquier/docs
Browse files Browse the repository at this point in the history
fix ascii art in docs
  • Loading branch information
AurelienJaquier authored Jun 24, 2024
2 parents 0e9654f + 59c5b4b commit a450fbd
Show file tree
Hide file tree
Showing 8 changed files with 138 additions and 126 deletions.
30 changes: 16 additions & 14 deletions bluepyefe/ecode/DeHyperPol.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,22 @@ class DeHyperPol(Recording):
The hyperpolarizing step is usually fixed at 150% of rheobase, and the hyperpolarizing step
can usually vary from -40% to -160% of rheobase.
`` hypamp hypamp+amp hypamp+amp2 hypamp ``
`` : : : : ``
`` : _________________ : : ``
`` : | | : : ``
`` : | | : : ``
``|_______________| | : ___________ ``
``^ ^ | : | ^ ``
``: : | : | : ``
``: : | : | : ``
``: : |____________| : ``
``: : ^ ^ : ``
``: : : : : ``
``: : : : : ``
``t=0 ton tmid toff tend``
.. code-block:: none
hypamp hypamp+amp hypamp+amp2 hypamp
: : : :
: _________________ : :
: | | : :
: | | : :
|_______________| | : ___________
^ ^ | : | ^
: : | : | :
: : | : | :
: : |____________| :
: : ^ ^ :
: : : : :
: : : : :
t=0 ton tmid toff tend
"""

def __init__(
Expand Down
33 changes: 17 additions & 16 deletions bluepyefe/ecode/HyperDePol.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,23 @@ class HyperDePol(Recording):
The hyperpolarizing step is usually fixed at 100% of rheobase, and the hyperpolarizing step
can usually vary from -40% to -160% of rheobase.
`` hypamp hypamp+amp hypamp+amp2 hypamp ``
`` : : : : ``
`` : : _____________________ : ``
`` : : | | : ``
`` : : | | : ``
`` : : | | : ``
`` : : | | : ``
`` : : | | : ``
``|_______________ : | |___________ ``
``^ | : | ^ ^ ``
``: |___________________| : : ``
``: ^ ^ : : ``
``: : : : : ``
``: : : : : ``
``t=0 ton tmid toff tend``
.. code-block:: none
hypamp hypamp+amp hypamp+amp2 hypamp
: : : :
: : _____________________ :
: : | | :
: : | | :
: : | | :
: : | | :
: : | | :
|_______________ : | |___________
^ | : | ^ ^
: |___________________| : :
: ^ ^ : :
: : : : :
: : : : :
t=0 ton tmid toff tend
"""

def __init__(
Expand Down
26 changes: 14 additions & 12 deletions bluepyefe/ecode/SpikeRec.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,18 +76,20 @@ class SpikeRec(Recording):

"""SpikeRec current stimulus
`` hypamp hypamp+amp hypamp hypamp+amp . . . ``
`` : : : : ``
`` : _________________ : _________________ _________________ ``
`` : | | : | | | | ``
`` : | | : | | * len(tspike) | | ``
`` : | | : | | . . . | | ``
`` : | | : | | | | ``
``|_______________| |__________| |__ __| |___ ``
``: : : : : ^ ``
``: : : : : : ``
``: : : : : : ``
`` <--tspike[0]--><-spike_duration-><- delta -><-spike_duration-> . . . tend``
.. code-block:: none
hypamp hypamp+amp hypamp hypamp+amp . . .
: : : :
: _________________ : _________________ _________________
: | | : | | | |
: | | : | | * len(tspike) | |
: | | : | | . . . | |
: | | : | | | |
|_______________| |__________| |__ __| |___
: : : : : ^
: : : : : :
: : : : : :
<--tspike[0] --><-spike_duration-><- delta -><-spike_duration-> . . . tend
"""

Expand Down
41 changes: 21 additions & 20 deletions bluepyefe/ecode/negCheops.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,27 @@ class NegCheops(Recording):

"""NegCheops current stimulus
`` hypamp hypamp+amp hypamp hypamp+amp hypamp hypamp+amp hypamp ``
`` : : : : : : : ``
`` : : : : : : : ``
``|__________ : ____________ : ____________ : ____________ ``
``: :\ : /: :\ : /: :\ : /: ^ ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ : / : : \ : / : : \ : / : : ``
``: : \ / : : \ / : : \ / : : ``
``: : ' : : ' : : ' : : ``
``: : : : : : : : ``
``t=0 ton t1 t2 t3 t4 toff tend``
.. code-block:: none
hypamp hypamp+amp hypamp hypamp+amp hypamp hypamp+amp hypamp
: : : : : : :
: : : : : : :
|__________ : ____________ : ____________ : ____________
: :\ : /: :\ : /: :\ : /: ^
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ : / : : \ : / : : \ : / : :
: : \ / : : \ / : : \ / : :
: : ' : : ' : : ' : :
: : : : : : : :
t=0 ton t1 t2 t3 t4 toff tend
"""

def __init__(
Expand Down
40 changes: 21 additions & 19 deletions bluepyefe/ecode/posCheops.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,27 @@ class PosCheops(Recording):

"""PosCheops current stimulus
`` hypamp hypamp+amp hypamp hypamp+amp hypamp hypamp+amp hypamp ``
`` : : : : : : : ``
`` : . : . : . : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
`` : / \ : / \ : / \ : ``
``|__________ / \ __________ / \ __________ / \ __________ ``
``: : : : : : : ^ ``
``: : : : : : : : ``
``: : : : : : : : ``
``t=0 ton t1 t2 t3 t4 toff tend``
.. code-block:: none
hypamp hypamp+amp hypamp hypamp+amp hypamp hypamp+amp hypamp
: : : : : : :
: . : . : . :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
: / \ : / \ : / \ :
|__________ / \ __________ / \ __________ / \ __________
: : : : : : : ^
: : : : : : : :
: : : : : : : :
t=0 ton t1 t2 t3 t4 toff tend
"""

def __init__(
Expand Down
Loading

0 comments on commit a450fbd

Please sign in to comment.