Update documentation

open-ephys · Jan 6, 2024 · db9aa79 · db9aa79
1 parent ba6fbaf
commit db9aa79
Show file tree

Hide file tree

Showing 299 changed files with 25,790 additions and 117 deletions.
diff --git a/EEA/Firmata_cajal.html b/EEA/Firmata_cajal.html
diff --git a/EEA/TA.html b/EEA/TA.html
diff --git a/EEA/acknowledgements.html b/EEA/acknowledgements.html
diff --git a/EEA/circuits.html b/EEA/circuits.html
diff --git a/EEA/disclaimer_terms_conditions.html b/EEA/disclaimer_terms_conditions.html
diff --git a/EEA/drawingcurrent.html b/EEA/drawingcurrent.html
diff --git a/EEA/exday1.html b/EEA/exday1.html
diff --git a/EEA/exday1TA.html b/EEA/exday1TA.html
diff --git a/EEA/exday1TA_nokit.html b/EEA/exday1TA_nokit.html
diff --git a/EEA/exday1_nokit.html b/EEA/exday1_nokit.html
diff --git a/EEA/exday2.html b/EEA/exday2.html
diff --git a/EEA/exday2TA.html b/EEA/exday2TA.html
diff --git a/EEA/exday2TA_nokit.html b/EEA/exday2TA_nokit.html
diff --git a/EEA/exday2_nokit.html b/EEA/exday2_nokit.html
diff --git a/EEA/exday3.html b/EEA/exday3.html
diff --git a/EEA/exday3TA.html b/EEA/exday3TA.html
diff --git a/EEA/exday4.html b/EEA/exday4.html
diff --git a/EEA/exday4TA.html b/EEA/exday4TA.html
diff --git a/EEA/finaldiffamp.html b/EEA/finaldiffamp.html
diff --git a/EEA/index.html b/EEA/index.html
diff --git a/EEA/kitlist.html b/EEA/kitlist.html
diff --git a/EEA/license.html b/EEA/license.html
diff --git a/EEA/projects.html b/EEA/projects.html
diff --git a/EEA/safety.html b/EEA/safety.html
diff --git a/EEA/sinewave.html b/EEA/sinewave.html
diff --git a/EEA/software_requirements.html b/EEA/software_requirements.html
diff --git a/EEA/soldiffamp.html b/EEA/soldiffamp.html
diff --git a/EEA/theoryday1.html b/EEA/theoryday1.html
diff --git a/EEA/theoryday2.html b/EEA/theoryday2.html
diff --git a/EEA/theoryday3.html b/EEA/theoryday3.html
diff --git a/EEA/theoryday4.html b/EEA/theoryday4.html
diff --git a/_images/2vs3bitresolution.png b/_images/2vs3bitresolution.png
diff --git a/_images/3bitADC.png b/_images/3bitADC.png
diff --git a/_images/ADC_saturation.png b/_images/ADC_saturation.png
diff --git a/_images/Analogdetectbuffered.svg b/_images/Analogdetectbuffered.svg
diff --git a/_images/aa_batteries_sim.png b/_images/aa_batteries_sim.png
diff --git a/_images/amp_headstage_blink.png b/_images/amp_headstage_blink.png
diff --git a/_images/arm.png b/_images/arm.png
diff --git a/_images/audio_sweep.png b/_images/audio_sweep.png
diff --git a/_images/audiocapture.png b/_images/audiocapture.png
diff --git a/_images/audiokeydown.png b/_images/audiokeydown.png
diff --git a/_images/audioplayback.png b/_images/audioplayback.png
diff --git a/_images/battery_terminal_spark.png b/_images/battery_terminal_spark.png
diff --git a/_images/bipolar_power_supply.png b/_images/bipolar_power_supply.png
diff --git a/_images/bipolar_sim_solution.png b/_images/bipolar_sim_solution.png
diff --git a/_images/bipolar_supply_sim.png b/_images/bipolar_supply_sim.png
diff --git a/_images/black_box_recording_system.png b/_images/black_box_recording_system.png
diff --git a/_images/blink_readout_picoscope.png b/_images/blink_readout_picoscope.png
diff --git a/_images/board_emg_picoscope.png b/_images/board_emg_picoscope.png
diff --git a/_images/board_emg_teensy.png b/_images/board_emg_teensy.png
diff --git a/_images/book_logo.png b/_images/book_logo.png
diff --git a/_images/box_logo.png b/_images/box_logo.png
diff --git a/_images/breadboard_connectivity.png b/_images/breadboard_connectivity.png
diff --git a/_images/cap_charging_picoscope.png b/_images/cap_charging_picoscope.png
diff --git a/_images/cap_freq_circuits.png b/_images/cap_freq_circuits.png
diff --git a/_images/cap_res_parallel_sim.png b/_images/cap_res_parallel_sim.png
diff --git a/_images/cap_voltage_div.png b/_images/cap_voltage_div.png
diff --git a/_images/capacitor_charge.png b/_images/capacitor_charge.png
diff --git a/_images/capacitor_membrane.png b/_images/capacitor_membrane.png
diff --git a/_images/charging_cap_photo.png b/_images/charging_cap_photo.png
diff --git a/_images/charging_cap_schematic.png b/_images/charging_cap_schematic.png
diff --git a/_images/charging_cap_sim.png b/_images/charging_cap_sim.png
diff --git a/_images/charging_cap_sim_solution.png b/_images/charging_cap_sim_solution.png
diff --git a/_images/circuit_double_layer_interface.png b/_images/circuit_double_layer_interface.png
diff --git a/_images/circuit_electrode_shunt_amp.png b/_images/circuit_electrode_shunt_amp.png
diff --git a/_images/circuit_electrode_shunt_capacitance.png b/_images/circuit_electrode_shunt_capacitance.png
diff --git a/_images/circuit_impedance_shunt_capacitance.png b/_images/circuit_impedance_shunt_capacitance.png
diff --git a/_images/circuitday2.png b/_images/circuitday2.png
diff --git a/_images/comparator_ladder.png b/_images/comparator_ladder.png
diff --git a/_images/coulombs_law_visual.png b/_images/coulombs_law_visual.png
diff --git a/_images/day2circuit.png b/_images/day2circuit.png
diff --git a/_images/day2withac.png b/_images/day2withac.png
diff --git a/_images/diff_amp.png b/_images/diff_amp.png
diff --git a/_images/diff_amp_unbalanced_resistors.png b/_images/diff_amp_unbalanced_resistors.png
diff --git a/_images/double_layer_interface.png b/_images/double_layer_interface.png
diff --git a/_images/electric_force_field.png b/_images/electric_force_field.png
diff --git a/_images/electric_potential.png b/_images/electric_potential.png
diff --git a/_images/electric_potential_spike.png b/_images/electric_potential_spike.png
diff --git a/_images/electrode_eq_circuit.png b/_images/electrode_eq_circuit.png
diff --git a/_images/emg_gain_resistor.png b/_images/emg_gain_resistor.png
diff --git a/_images/exposed_breadboard.png b/_images/exposed_breadboard.png
diff --git a/_images/fritz_bipolar_power_supply.png b/_images/fritz_bipolar_power_supply.png
diff --git a/_images/fritz_emg_picoscope.png b/_images/fritz_emg_picoscope.png
diff --git a/_images/fritz_emg_teensy.png b/_images/fritz_emg_teensy.png
diff --git a/_images/fritz_headstage_blink.png b/_images/fritz_headstage_blink.png
diff --git a/_images/fritz_wire_only_blink.png b/_images/fritz_wire_only_blink.png
diff --git a/_images/high_pass.png b/_images/high_pass.png
diff --git a/_images/inside_intan.png b/_images/inside_intan.png
diff --git a/_images/instr_amp_pinout.png b/_images/instr_amp_pinout.png
diff --git a/_images/instrumentation_amp_simulator.png b/_images/instrumentation_amp_simulator.png
diff --git a/_images/ledon.png b/_images/ledon.png
diff --git a/_images/low_pass.png b/_images/low_pass.png
diff --git a/_images/neg_feedback_voltage_div.png b/_images/neg_feedback_voltage_div.png
diff --git a/_images/ohmmeter_sim.png b/_images/ohmmeter_sim.png
diff --git a/_images/ohmmeter_sim_solution.png b/_images/ohmmeter_sim_solution.png
diff --git a/_images/op-amp-basic.png b/_images/op-amp-basic.png
diff --git a/_images/op_amp_feedback.png b/_images/op_amp_feedback.png
diff --git a/_images/op_amp_pinout.png b/_images/op_amp_pinout.png
diff --git a/_images/op_amp_spikes_ref.png b/_images/op_amp_spikes_ref.png
diff --git a/_images/open_loop_ref.png b/_images/open_loop_ref.png
diff --git a/_images/output_impedance.png b/_images/output_impedance.png
diff --git a/_images/point_source_equation.png b/_images/point_source_equation.png
diff --git a/_images/readout_teensy_voltage_photo.png b/_images/readout_teensy_voltage_photo.png
diff --git a/_images/readout_teensy_voltage_picoscope.png b/_images/readout_teensy_voltage_picoscope.png
diff --git a/_images/readout_teensy_voltage_schematic.png b/_images/readout_teensy_voltage_schematic.png
diff --git a/_images/resistors_amplifier_breadboard.png b/_images/resistors_amplifier_breadboard.png
diff --git a/_images/resistors_parallel_sim.png b/_images/resistors_parallel_sim.png
diff --git a/_images/resistors_series_sim.png b/_images/resistors_series_sim.png
diff --git a/_images/shunt_amplifier_voltage_divider.png b/_images/shunt_amplifier_voltage_divider.png
diff --git a/_images/sim_headstage_added.png b/_images/sim_headstage_added.png
diff --git a/_images/sim_reference_electrode.png b/_images/sim_reference_electrode.png
diff --git a/_images/sinewave_output.png b/_images/sinewave_output.png
diff --git a/_images/sinewave_teensy_pico.png b/_images/sinewave_teensy_pico.png
diff --git a/_images/singular_matrix.png b/_images/singular_matrix.png
diff --git a/_images/sinwave_sim_solution.png b/_images/sinwave_sim_solution.png
diff --git a/_images/squarewave_sim.png b/_images/squarewave_sim.png
diff --git a/_images/squarewave_sim_solution.png b/_images/squarewave_sim_solution.png
diff --git a/_images/teensy_LC.png b/_images/teensy_LC.png
diff --git a/_images/teensy_on_board.png b/_images/teensy_on_board.png
diff --git a/_images/three_op_amps.png b/_images/three_op_amps.png
diff --git a/_images/videowriter.png b/_images/videowriter.png
diff --git a/_images/voltage_div_breadboard_photo.png b/_images/voltage_div_breadboard_photo.png
diff --git a/_images/voltage_div_breadboard_schematic.png b/_images/voltage_div_breadboard_schematic.png
diff --git a/_images/voltage_divider.png b/_images/voltage_divider.png
diff --git a/_images/voltage_divider_sim_solution.png b/_images/voltage_divider_sim_solution.png
diff --git a/_images/voltage_divider_spike_solution.png b/_images/voltage_divider_spike_solution.png
diff --git a/_images/voltage_divider_teensy.png b/_images/voltage_divider_teensy.png
diff --git a/_images/voltmeter_sim.png b/_images/voltmeter_sim.png
diff --git a/_images/voltmeter_sim_solution.png b/_images/voltmeter_sim_solution.png
diff --git a/_images/wire_only_blink.png b/_images/wire_only_blink.png
diff --git a/_sources/EEA/Firmata_cajal.rst.txt b/_sources/EEA/Firmata_cajal.rst.txt
@@ -0,0 +1,83 @@
+.. _Firmata:
+
+***********************************
+Firmata for Cajal Course
+***********************************
+
+// Copy this text to a new sketch in the Arduino software (clear the default 'void loop etc first) and save as firmata_cajal.ino. Compile and upload to your Teensy. 
+
+.. code-block::
+
+  #include <Firmata.h>
+  byte analogPin;
+  byte previousPIN[TOTAL_PORTS];  // PIN means PORT for input
+  byte previousPORT[TOTAL_PORTS];
+
+  void outputPort(byte portNumber, byte portValue)
+  {
+    // only send the data when it changes, otherwise you get too many messages!
+    if (previousPIN[portNumber] != portValue) {
+      Firmata.sendDigitalPort(portNumber, portValue);
+      previousPIN[portNumber] = portValue;
+    }
+  }
+
+  void setPinModeCallback(byte pin, int mode) {
+    if (IS_PIN_DIGITAL(pin)) {
+      pinMode(PIN_TO_DIGITAL(pin), mode);
+    }
+  }
+
+  void analogWriteCallback(byte pin, int value)
+  {
+   pinMode(pin, OUTPUT);
+   analogWrite(pin, value);
+  }
+
+
+  void digitalWriteCallback(byte port, int value)
+  {
+    byte i;
+    byte currentPinValue, previousPinValue;
+
+    if (port < TOTAL_PORTS && value != previousPORT[port]) {
+      for (i = 0; i < 8; i++) {
+        currentPinValue = (byte) value & (1 << i);
+        previousPinValue = previousPORT[port] & (1 << i);
+        if (currentPinValue != previousPinValue) {
+          digitalWrite(i + (port * 8), currentPinValue);
+        }
+      }
+      previousPORT[port] = value;
+    }
+  }
+
+  void setup()
+  {
+   Firmata.setFirmwareVersion(FIRMATA_MAJOR_VERSION, FIRMATA_MINOR_VERSION);
+   Firmata.attach(ANALOG_MESSAGE, analogWriteCallback);
+   Firmata.attach(DIGITAL_MESSAGE, digitalWriteCallback);
+   Firmata.attach(SET_PIN_MODE, setPinModeCallback);
+   Firmata.begin();
+   delayMicroseconds(1000);
+  }
+
+  void loop()
+  {
+   while (Firmata.available()) {
+     Firmata.processInput();
+   }
+   delayMicroseconds(500);
+   for (analogPin = 0; analogPin < TOTAL_ANALOG_PINS; analogPin++) {
+     Firmata.sendAnalog(analogPin, analogRead(analogPin));
+   }
+   byte i;
+
+    for (i = 0; i < TOTAL_PORTS; i++) {
+      outputPort(i, readPort(i, 0xff));
+    }
+
+    while (Firmata.available()) {
+      Firmata.processInput();
+    }
+  }
diff --git a/_sources/EEA/TA.rst.txt b/_sources/EEA/TA.rst.txt
@@ -0,0 +1,23 @@
+******************************************
+TA files
+******************************************
+
+.. toctree::
+  :maxdepth:
+
+  exday1TA.rst
+  exday2TA.rst
+  exday3TA.rst
+  exday4TA.rst
+
+
+Exercises for teaching assistants
+###########################################
+
+:ref:`Exercises day 1 TA <refEDay1TA>`
+
+:ref:`Exercises day 2 TA <refEDay2TA>`
+
+:ref:`Exercises day 3 TA <refEDay3TA>`
+
+:ref:`Exercises day 4 TA <refEDay4TA>`
diff --git a/_sources/EEA/acknowledgements.rst.txt b/_sources/EEA/acknowledgements.rst.txt
@@ -0,0 +1,25 @@
+
+Acknowledgements
+###################################
+
+These materials were written by:
+
+* Alexandra Leighton
+* Joana Neto
+* Jakob Voigts
+* Aarón Cuevas López
+
+With material from:
+
+* Joana Neto, 2018; Materials and neuroscience: validating tools for large-scale, high-density neural recording, 2018.
+* Jon Newman and Jakob Voigts, 2017; Intro to Chronic Ephys (presentation at  `TENSS <https://www.tenss.ro/>`_)
+* Mitra Javadzadeh, 2017; Building an analog ephys recording system (practical exercises developed for  `TENSS <https://www.tenss.ro/>`_)
+* Circuit Simulator version 2.4.6js. Original by Paul Falstad, JavaScript conversion by Iain Sharp
+* Breadboard circuit illustration made in Fritzing 
+
+With thoughtful feedback from:
+
+* Antonin Blot
+* Filipe Carvalho
+* Jon Newman
+* Cecilia Herbert
diff --git a/_sources/EEA/circuits.rst.txt b/_sources/EEA/circuits.rst.txt
@@ -0,0 +1,52 @@
+Circuits
+
+
+circuit for electrode only with these values:
+https://tinyurl.com/yh7unqml
+
+- Gold plating does what to impedance?
+- 'Gold-plate' your electrode in the equivalent circuit by changing the appropriate component by a factor of 10. What happens to Vin?
+-
+
+
+demo with op amp: WIP
+
+https://tinyurl.com/ye7nc2ny
+
+
+
+
+with recording pc
+https://tinyurl.com/yzf5rjff
+
+
+
+electrode, headstage, leakage and shunt
+https://tinyurl.com/ygco6nqv
+
+
+
+measurement electrode, reference electrode, instrumentation amp
+https://tinyurl.com/yfsns7zj
+
+
+
+
+  The equivalent circuit of the acquisition system
+  ###################################################
+
+  circuit for electrode only with these values:
+  https://tinyurl.com/yh7unqml
+
+  - Gold plating does what to impedance?
+  - 'Gold-plate' your electrode in the equivalent circuit by changing the appropriate component by a factor of 10. What happens to Vin?
+  -
+
+  with recording pc
+  https://tinyurl.com/yzf5rjff
+
+  electrode, headstage, leakage and shunt
+  https://tinyurl.com/ygco6nqv
+
+  measurement electrode, reference electrode, instrumentation amp
+  https://tinyurl.com/yfsns7zj
diff --git a/_sources/EEA/disclaimer_terms_conditions.rst.txt b/_sources/EEA/disclaimer_terms_conditions.rst.txt
@@ -0,0 +1,15 @@
+***********************************
+Terms and Conditions
+***********************************
+
+Disclaimer
+###################################
+The authors assume no responsibility or liability for any errors or omissions in the content of this site. The information contained in this site is provided on an "as is" basis with no guarantees of completeness and/or accuracy.
+
+Use at your own risk
+###################################
+These materials are provided for educational use. Any action you take upon the documentation on this website is strictly at your own risk.
+
+Links To Other Sites
+###################################
+These pages contain links that will redirect you to third party websites that are not operated by us and that we do not take responsibility for. 
diff --git a/_sources/EEA/drawingcurrent.rst.txt b/_sources/EEA/drawingcurrent.rst.txt
@@ -0,0 +1,12 @@
+
+Why drawing current distorts signals
+*****************************************
+A perfect 5V voltage source would always provide exactly 5 Volts, no matter what the rest of the circuit looks like. If we put a lot of high impedance components in the rest of the circuit, less current will flow, and if we put low impedance components we will get a high current.
+
+A real voltage source has a bit of output impedance, which means it acts as a voltage source in series with an impedance. This is modelled here:
+
+https://tinyurl.com/yfvzdxbz
+
+That invisible, small series resistance creates a voltage divider. Though the actual source voltage is the same 5V, the apparent voltage of the source varies depending on the ratio between the output impedance of the source, and the impedance of the rest of the circuit. The lower the impedance of the components used in the rest of the circuit, the higher the relative influence of the source output impedance, and the lower the apparent source voltage.
+
+In our acquisition system, the voltage source are the potential changes in the extracellular fluid (Vec). The resistive and capacitive properties of the electrode create an output resistance. The relative impedance of the circuit before and after Vin influence the magnitude of the signal at Vin. If we allow a lot of current to flow from our electrode to ground, we have a low impedance circuit, and will distort our signal. We therefore need something that will stop current being drawn from our cells, and provide the necessary current itself from a different source. This is done by amplifiers, in the headstage.