Displays field data from Sim4Life simulations of spinal cord electrostimulation.

1. Download and install Python 3.8.4
2. Clone the repository

3. Save the CSF model vtk file to the base folder of the repository and rename it to CSF.vtk

   OR

   Change the DEFAULT csf_model variable in your local config.ini file to be the file path of the CSF model vtk file

4. Open a command prompt window and navigate to the repository

5. Run the following commands to set up the environment:

   python -m venv slvenv
   slvenv\Scripts\activate
   pip install -r requirements.txt

To run the application, run the following commands from a command prompt window located in the base folder of the repository:

slvenv\Scripts\activate
python run.py

To build the documentation:

1. Install the Sphinx, Read the Docs Sphinx Theme, and Numpydoc packages:

   pip install sphinx sphinx-rtd-theme numpydoc

2. Create a new directory $RepoHome$/docs/_build

3. Run the following command from the $RepoHome$/docs/ folder:

   make html