Skip to content

Commit 4db0828

Browse files
committed
Updated spikesafe_python_lib_docs
1 parent 7f42fb5 commit 4db0828

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

spikesafe_python_lib_docs/Compensation/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Provides a collection of helper functions you can use to help with SpikeSafe com
88
### Functions
99
| Name | Description |
1010
| - | - |
11-
| [get_custom_compensation(spikesafe_model_max_current_amps, set_current_amps, device_type, custom_compensation_table, pulse_on_time_seconds=None)](/spikesafe_python_lib_docs/Compensation/get_custom_compensation/README.md) | Returns the custom compensation values for a given set_current_amps and device_type based on a custom_compensation_table, and optionally a given pulse on time. |
12-
| [get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds: None)](/spikesafe_python_lib_docs/Compensation/get_optimum_compensation/README.md) | Returns the optimum compensation for a given set current, and optionally a given pulse on time. |
11+
| [get_custom_compensation(spikesafe_model_max_current_amps, set_current_amps, device_type, custom_compensation_table, pulse_on_time_seconds=None, enable_logging=True)](/spikesafe_python_lib_docs/Compensation/get_custom_compensation/README.md) | Returns the custom compensation values for a given set_current_amps and device_type based on a custom_compensation_table, and optionally a given pulse on time. |
12+
| [get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds=None, enable_logging=True)](/spikesafe_python_lib_docs/Compensation/get_optimum_compensation/README.md) | Returns the optimum compensation for a given set current, and optionally a given pulse on time. |
1313
| [load_custom_compensation_table(file_path)](/spikesafe_python_lib_docs/Compensation/load_custom_compensation_table/README.md) | Returns a custom compensation table from a JSON file. |
1414
| [load_custom_compensation_unique_device_types(custom_compensation_table)](/spikesafe_python_lib_docs/Compensation/load_custom_compensation_unique_device_types/README.md) | Returns the unique device types from a custom compensation table. |
1515

spikesafe_python_lib_docs/Compensation/get_custom_compensation/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [Compensation](/spikesafe_python_lib_docs/Compensation/README.md) | get_custom_compensation(spikesafe_model_max_current_amps, set_current_amps, device_type, custom_compensation_table, pulse_on_time_seconds=None)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [Compensation](/spikesafe_python_lib_docs/Compensation/README.md) | get_custom_compensation(spikesafe_model_max_current_amps, set_current_amps, device_type, custom_compensation_table, pulse_on_time_seconds=None, enable_logging=True)
22

3-
## get_custom_compensation(spikesafe_model_max_current_amps, set_current_amps, device_type, custom_compensation_table, pulse_on_time_seconds=None)
3+
## get_custom_compensation(spikesafe_model_max_current_amps, set_current_amps, device_type, custom_compensation_table, pulse_on_time_seconds=None, enable_logging=True)
44

55
### Definition
66
Returns the custom compensation values for a given set_current_amps and device_type based on a custom_compensation_table, and optionally a given pulse on time.
@@ -21,6 +21,9 @@ Custom compensation table to be used for compensation. This should be the result
2121
pulse_on_time_seconds [float](https://docs.python.org/3/library/functions.html#float) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
2222
Pulse On Time to be set on SpikeSafe
2323

24+
enable_logging [bool](https://docs.python.org/3/library/stdtypes.html#boolean-values) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
25+
Enables logging (default is True)
26+
2427
### Returns
2528
LoadImpedance [LoadImpedance](/spikesafe_python_lib_docs/SpikeSafeEnums/LoadImpedance/README.md)
2629
Load Impedance compensation value. This should be an instance of the LoadImpedance [IntEnum](https://docs.python.org/3/library/enum.html#enum.IntEnum) from SpikeSafeEnums

spikesafe_python_lib_docs/Compensation/get_optimum_compensation/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [Compensation](/spikesafe_python_lib_docs/Compensation/README.md) | get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds: None)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [Compensation](/spikesafe_python_lib_docs/Compensation/README.md) | get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds=None, enable_logging=True)
22

3-
## get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds: None)
3+
## get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds=None, enable_logging=True)
44

55
### Definition
66
Returns the optimum compensation for a given set current, and optionally a given pulse on time.
@@ -15,6 +15,9 @@ Current to be set on SpikeSafe
1515
pulse_on_time_seconds [float](https://docs.python.org/3/library/functions.html#float) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
1616
Pulse On Time to be set on SpikeSafe
1717

18+
enable_logging [bool](https://docs.python.org/3/library/stdtypes.html#boolean-values) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
19+
Enables logging (default is True)
20+
1821
### Returns
1922
LoadImpedance [LoadImpedance](/spikesafe_python_lib_docs/SpikeSafeEnums/LoadImpedance/README.md)
2023
Load Impedance compensation value. This should be an instance of the LoadImpedance [IntEnum](https://docs.python.org/3/library/enum.html#enum.IntEnum) from SpikeSafeEnums

0 commit comments

Comments
 (0)