Added uPDH box model

uPDHBox/ExampleUse.ipynb

+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "***\n",
+    "# Circuit Definition (For reference)\n",
+    "All yellow marked signal ports in the schematic are named as it is in the\n",
+    "zero model without any spaces.\n",
+    "Following are some useful node names to remember:\n",
+    "\n",
+    "|\tNode name\t|\tFunction/Parameter\t|\n",
+    "|\t---\t|\t---\t|\n",
+    "| ServoIn | Servo Input.|\n",
+    "| InMon | Input monitor.|\n",
+    "| OutMon | Output Monitor.|\n",
+    "| TP# | Test points in the main signal chain. Eg. TP4.|\n",
+    "| J3A | Servo Input BNC port.|\n",
+    "| J1A | Piezo BNC port.|\n",
+    "\n",
+    "The model provides options of setting the variable gain, switching Boost,\n",
+    "and inverter switch.\n",
+    "\n",
+    "|\tFunction\t|\tWhat does it do?\t|\tArguments and usage\t|\n",
+    "|\t---\t|\t---\t|\t---\t|\n",
+    "|\tVarGain(circuit, Rpot=None, G=None, Vg=None, vb=True, R27=1e3, R26=1e3)\t|\tSet variable gain\t|\tcircuit: Circuit object <br>Rpot:R7 potentiometer setting in Ohms (0-10kOhms)<br>Vg:Gain setting voltage<br>vb: verbose<br><br>R27, R26: Resitors associated to preamplifier again in AD8336.<br>One only needs to provide one of arguments Rpot, G, or Vg.\t|\n",
+    "|\tBoost(circuit,state)\t|\tSwitch on or off Boost. |\tcircuit: Circuit object <br>State: 'ON' or 'OFF'\t|\n",
+    "|\tInverter(circuit,state)\t|\tSwitch on or off inversiont. |\tcircuit: Circuit object <br>State: 'ON' or 'OFF'\t|\n",
+    "\n",
+    "## Importing the circuit definition"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from uPDHBox import uPDH, VarGain, Boost, Inverter\n",
+    "from copy import deepcopy\n",
+    "import numpy as np"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "SN01 = deepcopy(uPDH)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "***\n",
+    "### Adding anychanges to the circuit:\n",
+    "This is just for example."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "SN01['R30'].value=1.1e3"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "***\n",
+    "### Set variable gain"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "VarGain(SN01, Rpot=6.6e3)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "***\n",
+    "### Switch Boost and/or Inverter"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "Boost(SN01, 'Off')\n",
+    "Inverter(SN01, 'Off')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Simulating"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from zero.analysis import AcSignalAnalysis\n",
+    "\n",
+    "frequencies = np.logspace(-1, 5, 600)\n",
+    "Signal_analysis = AcSignalAnalysis(circuit=SN01)\n",
+    "TFServoInBoff = Signal_analysis.calculate(frequencies=frequencies, input_type=\"voltage\", node=\"ServoIn\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "TFServoInBoff.plot_responses(sink='outMon', scale_db=False)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "Boost(SN01, 'On')\n",
+    "Inverter(SN01, 'off')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "Signal_analysisBOn = AcSignalAnalysis(circuit=SN01)\n",
+    "TFServoInBon = Signal_analysisBOn.calculate(frequencies=frequencies, input_type=\"voltage\", node=\"ServoIn\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "TFServoInBon.plot_responses(sink='outMon', scale_db=False)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

uPDHBox/README.md

+# HAM-A Coil Drivers
+
+### Zero representation of LIGO HAM-A Coil Drivers
+
+## Purpose
+To have a single import point for creating a circuit object which represents
+Satellite Amplifier circuit board
+[LIGO-D0901351](https://dcc.ligo.org/LIGO-D0901351-v1).
+The code is written in jupyter notebook to easily understand the flow of code
+and which element (component and nodes) is which. The notebook in the end
+writes a script copy of itself which we can import out of this module.
+
+## Documentation
+All yellow marked signal ports in the schematic are named as it is in the
+zero model without any spaces.
+Following are some useful node names to remember:
+
+|	Node name	|	Function/Parameter	|
+|	---	|	---	|
+| ServoIn | Servo Input.|
+| InMon | Input monitor.|
+| OutMon | Output Monitor.|
+| TP# | Test points in the main signal chain. Eg. TP4.|
+| J3A | Servo Input BNC port.|
+| J1A | Piezo BNC port.|
+
+The model provides options of setting the variable gain, switching Boost,
+and inverter switch.
+
+|	Function	|	What does it do?	|	Arguments and usage	|
+|	---	|	---	|	---	|
+|	VarGain(circuit, Rpot=None, G=None, Vg=None, vb=True, R27=1e3, R26=1e3)	|	Set variable gain	|	circuit: Circuit object <br>Rpot:R7 potentiometer setting in Ohms (0-10kOhms)<br>Vg:Gain setting voltage<br>vb: verbose<br><br>R27, R26: Resitors associated to preamplifier again in AD8336.<br>One only needs to provide one of arguments Rpot, G, or Vg.	|
+|	Boost(circuit,state)	|	Switch on or off Boost. |	circuit: Circuit object <br>State: 'ON' or 'OFF'	|
+|	Inverter(circuit,state)	|	Switch on or off inversiont. |	circuit: Circuit object <br>State: 'ON' or 'OFF'	|
+
+## Contribution
+Everyone's contribution towards any bug fixes and additional features are most
+welcome but please make your changes in the notebook, save it and use 'restart
+and run all' function to generate equivalent script copy. This will ensure that
+the notebook and the script do not diverge from each other and we always have
+an up-to-date notebook environment to understand the circuit. Thanks!
+
+## Email
+Anchal Gupta - anchal@caltech.edu

uPDHBox/uPDHBox.ipynb

+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from zero import Circuit\n",
+    "from zero.components import Resistor, OpAmp\n",
+    "from math import log10"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Variable Gain Amplifier. Will be used by changing a0.\n",
+    "AD8336 = {'model': 'AD8336',\n",
+    "          'a0': 10,      # Nominal 20 dB gain. Will be changed.   \n",
+    "          'gbw': 80e6,\n",
+    "          'vnoise': '3n',\n",
+    "          'vcorner': 1e3,\n",
+    "          'inoise': '3p',\n",
+    "          'icorner': 1e3, # Guess\n",
+    "          'vmax': 10,\n",
+    "          'imax': 72e-3,\n",
+    "          'sr': 550e6}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Insertion Amplifier Stage"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "uPDH = Circuit()\n",
+    "uPDH.add_resistor(value=0, name='J3A', node1='ServoIn', node2='J3A')\n",
+    "uPDH.add_resistor(value=0, name='TP1', node1='ServoIn', node2='TP1')\n",
+    "uPDH.add_library_opamp(model='OP27', name='U1', node1='ServoIn', node2='n1', node3='InMon')\n",
+    "uPDH.add_resistor(value=49.9, name='R17', node1='ServoIn', node2='gnd')\n",
+    "uPDH.add_resistor(value=1e3, name='R14', node1='n1', node2='gnd')\n",
+    "uPDH.add_resistor(value=1e3, name='R12', node1='n1', node2='InMon')\n",
+    "uPDH.add_resistor(value=0, name='TP3', node1='InMon', node2='TP3')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Variable Gain Stage"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "uPDH.add_component(OpAmp(node1='InMon', node2='gnd',\n",
+    "                         node3='n2', name='U6', **AD8336))\n",
+    "def VarGain(circuit, Rpot=None, G=None, Vg=None, vb=True,\n",
+    "            R27=1e3, R26=1e3):\n",
+    "    preAmpGain = 20 * log10(1 + R26/R27)\n",
+    "    if Rpot is None:\n",
+    "        if G is None:\n",
+    "            if Vg is None:\n",
+    "                print('Error: Provide gain in dB or gain setting voltage in V.')\n",
+    "                print('Nothing changed.')\n",
+    "                return 0\n",
+    "            else:\n",
+    "                G = 50 * Vg + 4.4 + preAmpGain\n",
+    "    else:\n",
+    "        G = -11.19375 + Rpot * 3.11875e-3 + preAmpGain\n",
+    "    if G>30.0 or G<-10.0:\n",
+    "        print('Error: Gain can be set between -10dB to 30 dB only.')\n",
+    "        print('Nothing changed.')\n",
+    "        return 0\n",
+    "    circuit[\"U6\"].a0 = 10**(G/20) #Gain in absolute value\n",
+    "    if vb:\n",
+    "        print('Variable Gain set to '+str(round(G,2))+' dB.')\n",
+    "# Default potentiometer set to 6.6kOhms\n",
+    "VarGain(uPDH, Rpot=6.6e3)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Optional Transfer Function Stage"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "uPDH.add_resistor(value=0, name='TP13', node1='n2', node2='TP13')\n",
+    "uPDH.add_resistor(value=1e3, name='R29', node1='n2', node2='n4')\n",
+    "uPDH.add_resistor(value=1e3, name='R32', node1='n3', node2='gnd')\n",
+    "uPDH.add_library_opamp(model='OP27', name='U7', node1='n3', node2='n4', node3='n5', )\n",
+    "uPDH.add_resistor(value=1e3, name='R30', node1='n4', node2='n5')\n",
+    "uPDH.add_resistor(value=10, name='R31', node1='n4', node2='n6')\n",
+    "uPDH.add_capacitor(value=3.3e-6, name='C28', node1='n6', node2='n5')\n",
+    "uPDH.add_capacitor(value=3.3e-6, name='C18', node1='n7', node2='n4')\n",
+    "uPDH.add_resistor(value=0, name='TP16', node1='n5', node2='TP16')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Integrator Stage"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "uPDH.add_resistor(value=1e3, name='R23', node1='n5', node2='n9')\n",
+    "uPDH.add_resistor(value=1e3, name='R20', node1='n8', node2='gnd')\n",
+    "uPDH.add_library_opamp(model='LF356', name='U4', node1='n8', node2='n9', node3='n10')\n",
+    "uPDH.add_resistor(value=10, name='R24', node1='n9', node2='n12')\n",
+    "uPDH.add_capacitor(value=3.3e-6, name='C6', node1='n12', node2='n10')\n",
+    "uPDH.add_resistor(value=10e3, name='R16', node1='n11', node2='n10')\n",
+    "uPDH.add_capacitor(value=3.3e-6, name='C15', node1='n13', node2='n9')\n",
+    "uPDH.add_resistor(value=0, name='TP10', node1='n10', node2='TP10')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Boost Switch"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def Boost(circuit, state):\n",
+    "    boost = Resistor(name=\"boost\", value=\"0\", node1=\"n9\", node2=\"n11\")\n",
+    "    if state.upper() == 'ON':\n",
+    "        if circuit.has_component(boost):\n",
+    "            circuit.remove_component(boost)\n",
+    "            print('Switched ON Boost')\n",
+    "        else:\n",
+    "            print('Boost is already ON')\n",
+    "    elif state.upper() == 'OFF':\n",
+    "        if circuit.has_component(boost):\n",
+    "            print('Boost is already OFF')\n",
+    "        else:\n",
+    "            circuit.add_component(boost)\n",
+    "            print('Switched OFF Boost')\n",
+    "    else:\n",
+    "        print('Error: Use options ON or OFF')\n",
+    "        print('Nothing changed.')\n",
+    "\n",
+    "# Default Boost ON\n",
+    "Boost(uPDH,'ON')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Inverter and Piezo Driver Stage"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "uPDH.add_resistor(value=0, name='TP2', node1='n10', node2='TP2')\n",
+    "uPDH.add_resistor(value=10e3, name='R19', node1='n10', node2='n15')\n",
+    "uPDH.add_resistor(value=10e3, name='R21', node1='n10', node2='n14')\n",
+    "uPDH.add_library_opamp(model='OP27', name='U3', node1='n14', node2='n15', node3='n16')\n",
+    "uPDH.add_resistor(value=10e3, name='R15', node1='n15', node2='n16')\n",
+    "uPDH.add_resistor(value=0, name='TP4', node1='n16', node2='TP4')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Inverter Switch"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def Inverter(circuit,state):\n",
+    "    invert = Resistor(name=\"invert\", value=\"0\", node1=\"n14\", node2=\"gnd\")\n",
+    "    if state.upper() == 'OFF':\n",
+    "        if circuit.has_component(invert):\n",
+    "            circuit.remove_component(invert)\n",
+    "            print('Switched OFF inversion')\n",
+    "        else:\n",
+    "            print('Inversion is already OFF')\n",
+    "    elif state.upper() == 'ON':\n",
+    "        if circuit.has_component(invert):\n",
+    "            print('Inversion is already ON')\n",
+    "        else:\n",
+    "            circuit.add_component(invert)\n",
+    "            print('Switched ON inversion')\n",
+    "    else:\n",
+    "        print('Error: Use options ON or OFF')\n",
+    "        print('Nothing changed.')\n",
+    "\n",
+    "# Default invert ON\n",
+    "Inverter(uPDH,'ON')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "uPDH.add_resistor(value=10, name='R11', node1='n16', node2='OutMon')\n",
+    "uPDH.add_resistor(value=0, name='J1A', node1='OutMon', node2='J1A')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "!jupyter nbconvert --to script uPDHBox.ipynb\n",
+    "\n",
+    "# Delete the last cell\n",
+    "with open('uPDHBox.py','r') as f:\n",
+    "    lines = f.readlines()\n",
+    "for ii,line in enumerate(lines):\n",
+    "    if line.find('# In[') is not -1 and line.find('Skip This Line') == -1:\n",
+    "        lastCellLineNo = ii\n",
+    "newlines = lines[:lastCellLineNo]\n",
+    "with open('uPDHBox.py','w') as f:\n",
+    "    f.writelines(newlines)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}