Skip to content

Commit 300d799

Browse files
author
Paula
authored
Update README.md
1 parent 69de839 commit 300d799

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Neurofield
22

3-
This library implements methods to simulate neural field models,
4-
based on Robinson's Neural Field Theory.
3+
Neurofield is written in C++ and implements streamlined standard methods to solve hyperbolic partial differential equations such as the damped 2D wave equation; time stepping methods to solve ordinary differential equations; and procedures for delay differential equations. Careful numerical analysis has resulted in a suite of methods that is fast, accurate, and robust. Thus the present work obviates the need for users to become familiar with all these techniques and underlying theory, program them, and then debug several thousand lines of code. The code has been tailored to use these state equations to solve an unlimited number of user-defined continuum neural field models. The input and output files are both plain-text, so NeuroField can be easily integrated into existing workflows and analyses written in other programming languages.
4+
NeuroField comes with a collection of custom made Matlab functions that allow for an easy access to the compiled code, for users without prior knowledge of C++. End-users need only to write plain text files as described in the User Manual.
55

66

77
## Installation
@@ -59,3 +59,19 @@ Problems compiling? First check [the following page](https://github.com/BrainDyn
5959
## How to contribute code
6060

6161
If you intend to contribute to NeuroField development, please make a private fork of this repository and follow the [instructions for contributors.](https://github.com/BrainDynamicsUSYD/neurofield/wiki/How-to-contribute-code-to-NeuroField)
62+
63+
64+
## How to cite `NeuroField`
65+
66+
Liked the code? Did you use it in your research and got awesome results?
67+
68+
Please cite us as follows:
69+
70+
Sanz-Leon, P., Robinson, PA., Knock, SA., Drysdale, PM., Fung, PK., Abeysuriya, GM.,
71+
Rennie, CJ and Zhao, XL.
72+
73+
_NeuroField: Theory and Simulation of Multiscale Neural Field Dynamics_
74+
75+
presubmitted to PLoS Computational Biology
76+
77+

0 commit comments

Comments
 (0)