Merge branch 'main' of https://github.com/Bryce-Readyhough/caravel_UNCC_MPW_1 into main
diff --git a/README.md b/README.md
index d52e6c2..4b4ecf1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+
+
# Analog Spiking Neuron Circuit - Caravel Submission
This is the Google/EFabless/Skywater Caravel submission of an [Analog Spiking Neuron Circuit.](https://ieeexplore.ieee.org/document/9184447) The submission also includes a SONOS transistor array.
@@ -5,6 +7,7 @@
## Neuron circuit
The circuit in the original paper is in 130nm technology and has a vdd of 300mV. Skywater pdk is hybrid 180nm/130nm node where the minimum transistor length is 150nm.
As a result vdd needs to be higher in order to get the circuit to work properly. In simulation 700mV seems to work well.
+
<p align=”center”>
<img src="/doc/neuron.png" width="75%">
</p>
@@ -23,6 +26,12 @@
| vsyn1 | mprj_io[21] | axon_syn | mprj_io[30] |
| | | i_in | mprj_io[31] |
+### extracted netlist simulation
+Spiking pattern at v_buff for i_in = 10pA DC
+<p align=”center”>
+<img src="/doc/sample_sim.png" width="75%">
+</p>
+
## SONOS array
A 2x2 array of nfet sonos cells with transistor sizing 420nmx150nm.
<p align=”center”>
@@ -39,49 +48,33 @@
| BL1 | mprj_io[11] |
| SL1 | mprj_io[12] |
-[comment]: <> (<p align=”center”>)
-[comment]: <> (<img src="/doc/ciic_harness.png" width="75%" height="75%"> )
-[comment]: <> (</p>)
-# Installation and Usage
-To setup and install the repo for development:</br>
-<ol>
- <li>Install prerequisite tools:</li>
- <ol>
- <li>Install [Magic VLSI Layout Tool](http://opencircuitdesign.com/magic/)</li>
- <ol>
- <li>Note: As of the writing of this document the tool must be installed from sourcecode. The packaged version is not up to date for use with this repo.</li>
- </ol>
- <li>Install [KLayout VLSI Layout Tool](https://www.klayout.de/build.html)</li>
- <li>Install [SkywaterPDK](https://github.com/google/skywater-pdk) and [OpenPDK](https://github.com/RTimothyEdwards/open_pdks):</li>
- <ol>
- <li>Install Skywater PDK</li>
-
- export PDK_ROOT=(Absolute path where PDKs will be installed)
- cd $PDK_ROOT
- git clone https://github.com/google/skywater-pdk
- cd skywater-pdk
- git submodule init libraries/sky130_fd_io/latest
- git submodule init libraries/sky130_fd_pr/latest
- git submodule init libraries/sky130_fd_sc_hd/latest
- git submodule init libraries/sky130_fd_sc_hdll/latest
- git submodule init libraries/sky130_fd_sc_hs/latest
- git submodule init libraries/sky130_fd_sc_ms/latest
- git submodule init libraries/sky130_fd_sc_ls/latest
- git submodule init libraries/sky130_fd_sc_lp/latest
- git submodule init libraries/sky130_fd_sc_hvl/latest
- git submodule update
- make timing
-<li>Install OpenPDKs</li>
- git clone https://github.com/RTimothyEdwards/open_pdks.git
- cd open_pdks
- ./configure --with-sky130-source=$PDK_ROOT/skywater-pdk/libraries --with-sky130-local-path=$PDK_ROOT
- cd sky130
- make
- make install-local
-</ol>
-</ol>
-</ol>
-
-TODO: Finish Install instructions
+# Installation
+To setup and install the repo for development:
+
+1. Install prerequisite tools:
+ 1. Install [Magic VLSI Layout Tool](http://opencircuitdesign.com/magic/)
+ - Note: As of 12/7/2020 you must install Magic from source code. The packaged version will not work with OpenPDKS.
+ 2. Install [KLayout](https://www.klayout.de/build.html)
+ 3. Install [SkywaterPDK](https://github.com/google/skywater-pdk) and [OpenPDK](https://github.com/RTimothyEdwards/open_pdks) using [OpenLane](https://github.com/efabless/openlane.git)
+ 1. Clone and Install OpenLane. This will also grab and install SkywaterPDK and OpenPDK for you.
+
+```shell
+export PDK_ROOT=(where pdks will be installed)
+
+cd $PDK_ROOT
+
+git clone https://github.com/efabless/openlane.git -b mpw-one-a
+
+cd openlane
+export OPENLANE_ROOT=$(pwd)
+make
+```
+
+ 2. Clone and uncompress the repo
+
+```shell
+git clone https://github.com/Bryce-Readyhough/caravel_UNCC_MPW_1.git
+make uncompress -j$nproc
+```
diff --git a/doc/sample_sim.png b/doc/sample_sim.png
new file mode 100644
index 0000000..323dd1a
--- /dev/null
+++ b/doc/sample_sim.png
Binary files differ
