Skip to content

Commit

Permalink
add setting desc in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mzabolocki committed Nov 25, 2024
1 parent ea95514 commit 685c746
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,20 +121,34 @@ An example how to use the package is shown below:
method="cross-correlation",
time_unit="ms",
srate=30_000,
recording_length_t=600*1000)
recording_length_t=600*1000,
bin_size_t=1,
max_lag_t=100,)
# set the spike unit ids to be used for the analysis
spike_pairs = [(0, 6), (0, 7), (0, 8), (0, 9)]
# fit the model and report the monosynaptic connection results
snc.report(spike_pairs)
.. Example output for a report of a computational analysis of single-unit spike-train data is shown below:
.. .. image:: docs/img/report_summary.png # to change when live with full path
.. :alt: report_summary
.. :align: center
.. :width: 400px
**Define the settings**

The `SynaptiConn` object is initialized with the following settings:

- `spike_times` : dict
A dictionary of spike times for each neuron, where the keys are the neuron IDs, and the values are arrays of spike times.
- `method` : str
The method to use for inferring connections. Currently, only 'cross-correlation' is supported. This will be expanded in future versions.
- `time_unit` : str
The time unit of the spike times. Currently, only 'ms' is supported. This will be expanded in future versions.
- `srate` : float
The sampling rate of the spike times, in Hz.
- `recording_length_t` : float
The length of the recording, in the same time unit as the spike times.
- `bin_size_t` : float
The size of the bins to use for the cross-correlation analysis, in the same time unit as the spike times.
- `max_lag_t` : float
The maximum lag to use for the cross-correlation analysis, in the same time unit as the spike times.

**Note that a full set of examples and tutorials are provided in the documentation.
These provide a more detailed overview of how to use the package, and how to interpret the results.**
Expand Down

0 comments on commit 685c746

Please sign in to comment.