EStimLibrary

A C# library to facilitate electrical stimulation research and development.

More details coming soon.

Repo Structure

• src/ - the library source code
• tests/ - the test projects
• models/ - examples of spatial model definition files
• examples/ - example applications using the library's high-level API
• docs/ - additional documentation files, including a dictionary and coding conventions

UML Diagrams

Last updated: March 2024

• Class Diagram
• Sequence and Use Case Diagrams

Beneficial in the future:

• package diagram showing the interface exposed to the public
• use case, sequence, and/or activity diagram(s) depicting how this codebase interacts with a calling UI, the different objects instantiated at run-time, the function calls and messages passed between, the synchronous vs asynchronous functioning, etc
• class diagram of the robot and UI code (in their respective repos if not included here)
• deployment model of the whole networked system

See UML.md for a UML intro.