Skip to content

Commit

Permalink
use github links instead of readthedocs in readme and example
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaquier Aurélien Tristan committed Nov 8, 2024
1 parent 6765ebc commit 2598174
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ To get a list with all the available feature names
efel.get_feature_names()
```

Note that the extra-cellular features, the bpap_attenuation feature and the check_ais_initiation feature are not listed above because they have to be used in a special way, as described [here](https://efel.readthedocs.io/en/latest/extrafeats_example.html) for extra-cellular features, [here](https://efel.readthedocs.io/en/latest/eFeatures.html#bpap-attenuation) for bpap_attenuation feature and [here](https://efel.readthedocs.io/en/latest/eFeatures.html#check-ais-initiation) for check_ais_initiation feature.
Note that the extra-cellular features, the bpap_attenuation feature and the check_ais_initiation feature are not listed above because they have to be used in a special way, as described [here](https://github.com/BlueBrain/eFEL/blob/master/examples/extracellular/extrafeats_example.ipynb) for extra-cellular features, [here](https://github.com/BlueBrain/eFEL/blob/master/docs/source/eFeatures.rst#bpap_attenuation) for bpap_attenuation feature and [here](https://github.com/BlueBrain/eFEL/blob/master/docs/source/eFeatures.rst#check_ais_initiation) for check_ais_initiation feature.

To change the spike detection threshold setting (default is -20 mV)

Expand Down
2 changes: 1 addition & 1 deletion docs/source/python_example1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To get a list with all the available eFeature names::
efel.get_feature_names()

Note that the extra-cellular features, the bpap_attenuation feature and the check_ais_initiation feature are not listed above because they have to be used in a special way,
as described `here <https://efel.readthedocs.io/en/latest/extrafeats_example.html>`_ for extra-cellular features, `here <https://efel.readthedocs.io/en/latest/eFeatures.html#bpap-attenuation>`_ for bpap_attenuation feature and `here <https://efel.readthedocs.io/en/latest/eFeatures.html#check-ais-initiation>`_ for check_ais_initiation feature.
as described `here <https://github.com/BlueBrain/eFEL/blob/master/examples/extracellular/extrafeats_example.ipynb>`_ for extra-cellular features, `here <https://github.com/BlueBrain/eFEL/blob/master/docs/source/eFeatures.rst#bpap_attenuation>`_ for bpap_attenuation feature and `here <https://github.com/BlueBrain/eFEL/blob/master/docs/source/eFeatures.rst#check_ais_initiation>`_ for check_ais_initiation feature.

The python function to extract eFeatures is get_feature_values(...).
Below is a short example on how to use this function.
Expand Down

0 comments on commit 2598174

Please sign in to comment.