## Please edit system and help pages ONLY in the master wiki!
## For more information, please see MoinMoin:MoinDev/Translation.
##master-page:FrontPage
#format wiki
#language en
#pragma section-numbers off

= Minimum Working Example =
This is a minimum working example of the !WraptMor model. This demonstrates how to use ''!WraptMor.py'' to calculate the insertion-to-insertion length and wrapping points for a ligament fiber. The script also creates a visualization of the ligament fiber wrapping around the femur and tibia.

== Python Setup ==
The following modules are required to run !WraptMor. The code has been tested with the given version numbers.
 * Python version 3.8
 * vtk version 9.0.1
 * numpy version 1.19.1
 * scipy version 1.5.0

Experienced python users can use the environment file ''!WraptMor.yml'' to setup dependencies.

Users unfamiliar with Python can install a distribution of Python called ''Anaconda'' ([[https://www.anaconda.com/]]). Installing ''Anaconda'' will install Python, and the ''numpy'' and ''scipy'' packages (along with many other packages). Once ''Anaconda'' is installed, open a terminal/command prompt and enter this command to install the vtk package:

{{{
    pip install vtk
}}}

== Usage ==
To run ''!MinimumWorkingExample.py'', first checkout the ''!WraptMor'' repository. Open a terminal/command prompt and navigate to ''path/to/WraptMor''. Enter the command:

{{{
    python Examples/MinimumWorkingExample.py dat/Surfaces/oks003_TBB_Smooth.stl dat/Surfaces/oks003_FMB_Smooth.stl dat/Insertions/sMclProxLine.fcsv 1.
}}}

The inputs are described as follows:
{{{
    python Examples/MinimumWorkingExample.py surface0_fileName surface1_fileName insertionPoints_fileName surfaceClipDistance
}}}

The visualization that is generated by ''!MinimumWorkingExample.py'':

{{attachment:ExampleVisualization.png|Minimum working example visualization|width=300}}