Skip to content

Commit 8ff551e

Browse files
author
Alexander Ororbia
committed
update to docs
1 parent b9a1e64 commit 8ff551e

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
1-
# ngc-lib
1+
# ngc-lib: Support Library for ngc-learn
22

3-
<b>ngc-lib</b> is a pure Python library for conducting general (abstract)
4-
simulation of complex adaptive systems composed of dynamical components.
5-
6-
This is specifically the central library dependency for
3+
<b>ngc-lib</b> is the support library and central dependency for
74
<i><a href="https://github.com/NACLab/ngc-learn/">ngc-learn</a></i>, a library
85
designed for computational neuroscience and cognitive neuroscience research.
9-
This package is is distributed under the 3-Clause BSD license.
10-
11-
It is currently maintained by the
12-
<a href="https://www.cs.rit.edu/~ago/nac_lab.html">Neural Adaptive Computing (NAC) laboratory</a>.
6+
While ngc-learn contains the JAX-implemented routines and any supporting C
7+
code, ngc-lib is a pure Python package, primarily meant for providing the
8+
machinery, routines, and utilities that facilitate the general (abstract)
9+
simulation of complex adaptive systems made up of dynamical components. For
10+
information, including anything related to usage instructions and details,
11+
please refer to the ngc-learn README:
12+
https://github.com/NACLab/ngc-learn/.
13+
14+
This package is is distributed under the 3-Clause BSD license. It is currently
15+
maintained by the
16+
<a href="https://www.cs.rit.edu/~ago/nac_lab.html">Neural Adaptive Computing
17+
(NAC) laboratory</a>.
1318

1419
## <b>Installation:</b>
1520

@@ -23,7 +28,7 @@ following bash command:
2328
<pre>
2429
$ pip install .
2530
</pre>
26-
or, if you are doing development, then do an editable install via:
31+
or, if you are doing development, then do an editable install via:
2732
<pre>
2833
$ pip install --editable . # OR pip install -e .
2934
</pre>

0 commit comments

Comments
 (0)