summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/tikz-nef/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-07-21 20:18:00 +0000
committerKarl Berry <karl@freefriends.org>2018-07-21 20:18:00 +0000
commit693e9b84c86263c17dec3df20ba5a70cf64d8a97 (patch)
treeb9bfa6525785d6141fb2f3cd171a1102d6da0267 /Master/texmf-dist/doc/latex/tikz-nef/README.md
parent58c3ccb13744cf5db852f434570b36b1d3f25cff (diff)
tikz-nef (21jul18)
git-svn-id: svn://tug.org/texlive/trunk@48240 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tikz-nef/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/tikz-nef/README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/tikz-nef/README.md b/Master/texmf-dist/doc/latex/tikz-nef/README.md
new file mode 100644
index 00000000000..f0dec40afef
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tikz-nef/README.md
@@ -0,0 +1,46 @@
+# tikz-nef
+The *nef* TikZ library provides predefined styles and shapes to create diagrams
+ for neural networks constructed with the methods of the Neural Engineering
+ Framework (NEF) [1].
+
+![Gated difference integrator example.](https://raw.githubusercontent.com/jgosmann/tikz-nef/master/example-net.png)
+
+The example above was generated with this code:
+
+```latex
+\begin{tikzpicture}[nef]
+ \graph {
+ input [ext] -> gate [ens] -> integrator/$x$ [ens] -> output [ext];
+ integrator -> [bend right, "$-1$"] gate;
+ integrator -> [recurrent] integrator;
+ store -> [inhibit] gate;
+ };
+\end{tikzpicture}
+```
+
+The following styles are supported:
+
+* ea: ensemble array
+* ens: ensemble
+* ext: external input or output
+* inhibt: inhibitory connection
+* net: network
+* pnode: pass-through node
+* rect: rectification ensemble
+* recurrent: recurrent connection
+
+## Installation
+
+While this package is not available in [CTAN](https://ctan.org/) follow these
+instruction:
+
+1. Create the required installation directory (if not already existing):
+ `mkdir -p "$(kpsewhich -var-value TEXMFHOME)/tex/generic"`
+2. `cd "$(kpsewhich -var-value TEXMFHOME)/tex/generic"`
+3. `git clone https://github.com/jgosmann/tikz-nef.git`
+
+## References
+
+[1]: Chris Eliasmith and Charles H. Anderson. Neural engineering: Computation,
+ representation, and dynamics in neurobiological systems. MIT Press,
+ Cambridge, MA, 2003.