Skip to content

Commit 7f3cfc7

Browse files
committed
Switched all samples to use new design specifying class name for accessing spikesafe-python static methods and enums
1 parent 002c043 commit 7f3cfc7

File tree

32 files changed

+74
-74
lines changed

32 files changed

+74
-74
lines changed

spikesafe_python_lib_docs/Compensation/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ 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, enable_logging=False)](/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-
| [spikesafe_python.Compensation.get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds=None, enable_logging=False)](/spikesafe_python_lib_docs/Compensation/spikesafe_python.Compensation.get_optimum_compensation/README.md) | Returns the optimum compensation for a given set current, and optionally a given pulse on time. |
13-
| [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. |
14-
| [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. |
11+
| [Compensation.get_custom_compensation(spikesafe_model_max_current_amps, set_current_amps, device_type, custom_compensation_table, pulse_on_time_seconds=None, enable_logging=False)](/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+
| [Compensation.get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds=None, enable_logging=False)](/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. |
13+
| [Compensation.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. |
14+
| [Compensation.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

1616
### Schemas
1717
| Name | Description |

spikesafe_python_lib_docs/Compensation/get_custom_compensation/README.md

Lines changed: 2 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, enable_logging=False)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [Compensation](/spikesafe_python_lib_docs/Compensation/README.md) | Compensation.get_custom_compensation(spikesafe_model_max_current_amps, set_current_amps, device_type, custom_compensation_table, pulse_on_time_seconds=None, enable_logging=False)
22

3-
## get_custom_compensation(spikesafe_model_max_current_amps, set_current_amps, device_type, custom_compensation_table, pulse_on_time_seconds=None, enable_logging=False)
3+
## Compensation.get_custom_compensation(spikesafe_model_max_current_amps, set_current_amps, device_type, custom_compensation_table, pulse_on_time_seconds=None, enable_logging=False)
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.

spikesafe_python_lib_docs/Compensation/get_optimum_compensation/README.md

Lines changed: 2 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) | spikesafe_python.Compensation.get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds=None, enable_logging=False)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [Compensation](/spikesafe_python_lib_docs/Compensation/README.md) | Compensation.get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds=None, enable_logging=False)
22

3-
## spikesafe_python.Compensation.get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds=None, enable_logging=False)
3+
## Compensation.get_optimum_compensation(spikesafe_model_max_current_amps, set_current_amps, pulse_on_time_seconds=None, enable_logging=False)
44

55
### Definition
66
Returns the optimum compensation for a given set current, and optionally a given pulse on time.

spikesafe_python_lib_docs/Compensation/load_custom_compensation_table/README.md

Lines changed: 2 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) | load_custom_compensation_table(file_path)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [Compensation](/spikesafe_python_lib_docs/Compensation/README.md) | Compensation.load_custom_compensation_table(file_path)
22

3-
## load_custom_compensation_table(file_path)
3+
## Compensation.load_custom_compensation_table(file_path)
44

55
### Definition
66
Returns a custom compensation table from a JSON file.

spikesafe_python_lib_docs/Compensation/load_custom_compensation_unique_device_types/README.md

Lines changed: 2 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) | load_custom_compensation_unique_device_types(custom_compensation_table)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [Compensation](/spikesafe_python_lib_docs/Compensation/README.md) | Compensation.load_custom_compensation_unique_device_types(custom_compensation_table)
22

3-
## load_custom_compensation_unique_device_types(custom_compensation_table)
3+
## Compensation.load_custom_compensation_unique_device_types(custom_compensation_table)
44

55
### Definition
66
Returns the unique device types from a custom compensation table.

spikesafe_python_lib_docs/DigitizerDataFetch/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Provides a collection of helper functions you can use to take PSMU Digitizer mea
88
### Functions
99
| Name | Description |
1010
| - | - |
11-
| [spikesafe_python.DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/spikesafe_python.fetch_voltage_data/README.md) | Returns an array of voltage readings from the digitizer obtained through a fetch query. |
12-
| [fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_custom/README.md) | Returns an array of voltage readings using custom sampling mode from the digitizer obtained through a fetch query. |
13-
| [fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_linear/README.md) | Returns an array of voltage readings using linear sampling mode from the digitizer obtained through a fetch query. |
14-
| [fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_logarithmic/README.md) | Returns an array of voltage readings using logarithmic sampling mode from the digitizer obtained through a fetch query. |
15-
| [get_new_voltage_data_estimated_complete_time(aperture_microseconds, reading_count, hardware_trigger_count=None, hardware_trigger_delay_microseconds=None)](/spikesafe_python_lib_docs/DigitizerDataFetch/get_new_voltage_data_estimated_complete_time/README.md) | Returns the estimated minimum possible time in seconds it will take for the SpikeSafe PSMU digitizer to acquire new voltage readings. If hardware triggering is used, this does not take into account the pulse period, so the actual time may be longer. |
16-
| [spikesafe_python.DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/spikesafe_python.wait_for_new_voltage_data/README.md) | Queries the SpikeSafe PSMU digitizer until it responds that it has acquired new data. |
11+
| [DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data/README.md) | Returns an array of voltage readings from the digitizer obtained through a fetch query. |
12+
| [DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_custom/README.md) | Returns an array of voltage readings using custom sampling mode from the digitizer obtained through a fetch query. |
13+
| [DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_linear/README.md) | Returns an array of voltage readings using linear sampling mode from the digitizer obtained through a fetch query. |
14+
| [DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_logarithmic/README.md) | Returns an array of voltage readings using logarithmic sampling mode from the digitizer obtained through a fetch query. |
15+
| [DigitizerDataFetch.get_new_voltage_data_estimated_complete_time(aperture_microseconds, reading_count, hardware_trigger_count=None, hardware_trigger_delay_microseconds=None)](/spikesafe_python_lib_docs/DigitizerDataFetch/get_new_voltage_data_estimated_complete_time/README.md) | Returns the estimated minimum possible time in seconds it will take for the SpikeSafe PSMU digitizer to acquire new voltage readings. If hardware triggering is used, this does not take into account the pulse period, so the actual time may be longer. |
16+
| [DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/wait_for_new_voltage_data/README.md) | Queries the SpikeSafe PSMU digitizer until it responds that it has acquired new data. |

spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data/README.md

Lines changed: 2 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) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | spikesafe_python.DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None)
22

3-
## spikesafe_python.DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None)
3+
## DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None)
44

55
### Definition
66
Returns an array of voltage readings from the digitizer obtained through a fetch query.

spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_custom/README.md

Lines changed: 2 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) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None)
22

3-
## fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None)
3+
## DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None)
44

55
### Definition
66
Returns an array of voltage readings using custom sampling mode from the digitizer obtained through a fetch query.

spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_linear/README.md

Lines changed: 2 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) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None)
22

3-
## fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None)
3+
## DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None)
44

55
### Definition
66
Returns an array of voltage readings using linear sampling mode from the digitizer obtained through a fetch query .

spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_logarithmic/README.md

Lines changed: 2 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) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None)
22

3-
## fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None)
3+
## DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None)
44

55
### Definition
66
Returns an array of voltage readings using logarithmic sampling mode from the digitizer obtained through a fetch query.

0 commit comments

Comments
 (0)