diff --git a/bluepyefe/auto_targets.py b/bluepyefe/auto_targets.py index dd4685b..8215b40 100644 --- a/bluepyefe/auto_targets.py +++ b/bluepyefe/auto_targets.py @@ -24,7 +24,7 @@ class AutoTarget(): """Fuzzy targets defined by lists of ecodes, amplitudes and efeatures. The AutoTarget will try to find the best combination of ecodes, amplitudes - and efeatures that match the data available in the recordings.""" + and efeatures that match the data available in the recordings.""" def __init__( self, diff --git a/bluepyefe/ecode/DeHyperPol.py b/bluepyefe/ecode/DeHyperPol.py index b6e6a02..de146b1 100644 --- a/bluepyefe/ecode/DeHyperPol.py +++ b/bluepyefe/ecode/DeHyperPol.py @@ -29,6 +29,24 @@ class DeHyperPol(Recording): + """DeHyperpol current stimulus + + hypamp hypamp+amp hypamp+amp2 hypamp + : : : : + : _________________ : : + : | | : : + : | | : : + |_______________| | : ___________ + ^ ^ | : | ^ + : : | : | : + : : | : | : + : : |____________| : + : : ^ ^ : + : : : : : + : : : : : + t=0 ton tmid toff tend + """ + def __init__( self, config_data, diff --git a/bluepyefe/ecode/HyperDePol.py b/bluepyefe/ecode/HyperDePol.py index bb105fd..0ecac43 100644 --- a/bluepyefe/ecode/HyperDePol.py +++ b/bluepyefe/ecode/HyperDePol.py @@ -28,6 +28,27 @@ class HyperDePol(Recording): + + """HyperDepol current stimulus + + + hypamp hypamp+amp hypamp+amp2 hypamp + : : : : + : : _____________________ : + : : | | : + : : | | : + : : | | : + : : | | : + : : | | : + |_______________ : | |___________ + ^ | : | ^ ^ + : |___________________| : : + : ^ ^ : : + : : : : : + : : : : : + t=0 ton tmid toff tend + """ + def __init__( self, config_data, diff --git a/bluepyefe/ecode/SpikeRec.py b/bluepyefe/ecode/SpikeRec.py index cf39d9e..ad93f0c 100644 --- a/bluepyefe/ecode/SpikeRec.py +++ b/bluepyefe/ecode/SpikeRec.py @@ -73,6 +73,24 @@ def detect_spike(amp, hypamp, smooth_current, dt): class SpikeRec(Recording): + + """SpikeRec current stimulus + + hypamp hypamp+amp hypamp hypamp+amp . . . + : : : : + : _________________ : _________________ _________________ + : | | : | | | | + : | | : | | * len(tspike) | | + : | | : | | . . . | | + : | | : | | | | + |_______________| |__________| |__ __| |___ + : : : : : ^ + : : : : : : + : : : : : : + <--tspike[0]--><-spike_duration-><- delta -><-spike_duration-> . . . tend + + """ + def __init__( self, config_data, diff --git a/bluepyefe/ecode/negCheops.py b/bluepyefe/ecode/negCheops.py index a501a82..7fcc4ef 100644 --- a/bluepyefe/ecode/negCheops.py +++ b/bluepyefe/ecode/negCheops.py @@ -28,6 +28,33 @@ class NegCheops(Recording): + + # pylint: disable=line-too-long,anomalous-backslash-in-string + + """NegCheops current stimulus + + + hypamp hypamp+amp hypamp hypamp+amp hypamp hypamp+amp hypamp + : : : : : : : + : : : : : : : + |__________ : ____________ : ____________ : ____________ + : :\ : /: :\ : /: :\ : /: ^ + : : \ : / : : \ : / : : \ : / : : + : : \ : / : : \ : / : : \ : / : : + : : \ : / : : \ : / : : \ : / : : + : : \ : / : : \ : / : : \ : / : : + : : \ : / : : \ : / : : \ : / : : + : : \ : / : : \ : / : : \ : / : : + : : \ : / : : \ : / : : \ : / : : + : : \ : / : : \ : / : : \ : / : : + : : \ : / : : \ : / : : \ : / : : + : : \ : / : : \ : / : : \ : / : : + : : \ / : : \ / : : \ / : : + : : ' : : ' : : ' : : + : : : : : : : : + t=0 ton t1 t2 t3 t4 toff tend + """ + def __init__( self, config_data, diff --git a/bluepyefe/ecode/posCheops.py b/bluepyefe/ecode/posCheops.py index 8697e45..5f3b263 100644 --- a/bluepyefe/ecode/posCheops.py +++ b/bluepyefe/ecode/posCheops.py @@ -28,6 +28,32 @@ class PosCheops(Recording): + + # pylint: disable=line-too-long,anomalous-backslash-in-string + + """PosCheops current stimulus + + hypamp hypamp+amp hypamp hypamp+amp hypamp hypamp+amp hypamp + : : : : : : : + : . : . : . : + : / \ : / \ : / \ : + : / \ : / \ : / \ : + : / \ : / \ : / \ : + : / \ : / \ : / \ : + : / \ : / \ : / \ : + : / \ : / \ : / \ : + : / \ : / \ : / \ : + : / \ : / \ : / \ : + : / \ : / \ : / \ : + : / \ : / \ : / \ : + : / \ : / \ : / \ : + |__________ / \ __________ / \ __________ / \ __________ + : : : : : : : ^ + : : : : : : : : + : : : : : : : : + t=0 ton t1 t2 t3 t4 toff tend + """ + def __init__( self, config_data, diff --git a/bluepyefe/ecode/ramp.py b/bluepyefe/ecode/ramp.py index cd4a84c..dd23f84 100644 --- a/bluepyefe/ecode/ramp.py +++ b/bluepyefe/ecode/ramp.py @@ -29,6 +29,29 @@ class Ramp(Recording): + + """Ramp current stimulus + + + hypamp hypamp+amp hypamp + : : : + : : : + : /| : + : / | : + : / | : + : / | : + : / | : + : / | : + : / | : + : / | : + : / | : + |___________ / |__________________________ + ^ ^ ^ ^ + : : : : + : : : : + t=0 ton toff tend + """ + def __init__( self, config_data, diff --git a/bluepyefe/ecode/sAHP.py b/bluepyefe/ecode/sAHP.py index e1d376c..b901930 100644 --- a/bluepyefe/ecode/sAHP.py +++ b/bluepyefe/ecode/sAHP.py @@ -29,6 +29,25 @@ class SAHP(Recording): + + """sAHP current stimulus + + + hypamp hypamp+amp hypamp+amp2 hypamp+amp hypamp + : : : : : + : : ______________ : : + : : | | : : + : ____________________| |____________________ : + : | ^ ^ | : + : | : : | : + |__________| : : |__________________ + ^ ^ : : ^ ^ + : : : : : : + : : : : : : + t=0 ton tmid tmid2 toff tend + + """ + def __init__( self, config_data, diff --git a/bluepyefe/ecode/sineSpec.py b/bluepyefe/ecode/sineSpec.py index 59b3ce1..dea899e 100644 --- a/bluepyefe/ecode/sineSpec.py +++ b/bluepyefe/ecode/sineSpec.py @@ -29,6 +29,9 @@ class SineSpec(Recording): + + """SineSpec current stimulus""" + def __init__( self, config_data, diff --git a/bluepyefe/ecode/step.py b/bluepyefe/ecode/step.py index b89e79a..0cddc28 100644 --- a/bluepyefe/ecode/step.py +++ b/bluepyefe/ecode/step.py @@ -29,6 +29,24 @@ class Step(Recording): + + """Step current stimulus + + hypamp hypamp+amp hypamp + : : : + : : : + : ______________________ : + : | | : + : | | : + : | | : + : | | : + |__________________| |______________________ + ^ ^ ^ ^ + : : : : + : : : : + t=0 ton toff tend + """ + def __init__( self, config_data, diff --git a/tox.ini b/tox.ini index a86e46c..77c3218 100644 --- a/tox.ini +++ b/tox.ini @@ -30,7 +30,7 @@ passenv = https_proxy, USER, KRB5CCNAME commands = make clean - style: pycodestyle --ignore=E402,W503,W504,E203,E501,E722 bluepyefe + style: pycodestyle --ignore=E402,W503,W504,E203,E501,E722,W605 bluepyefe syntax: flake8 . --count --select=E9,F63,F72,F82 --show-source --statistics functional: pytest --cov-report=xml --cov=bluepyefe --cov=tests --cov-config=.coveragerc -vx tests