Skip to content

Commit 91ce059

Browse files
Improve formatting in README.md
Updated README to include line breaks for better formatting and readability.
1 parent b07d16e commit 91ce059

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,10 @@ This computational tool uses optimal control to predict muscle activity of mouse
33

44
If you use this computational tool for your research, please cite:
55

6-
Gilmer, Jesse I., Susan K. Coltman, Geraldine Cuenu, John R. Hutchinson, Daniel Huber, Abigail L. Person, and Mazen Al Borno. "A novel biomechanical model of the proximal mouse forelimb predicts muscle activity in optimal control simulations of reaching movements." _Journal of neurophysiology_ 133, no. 4 (2025): 1266-1278.
6+
Gilmer, Jesse I., Susan K. Coltman, Geraldine Cuenu, John R. Hutchinson, Daniel Huber, Abigail L. Person, and Mazen Al Borno. "A novel biomechanical model of the proximal mouse forelimb predicts muscle activity in optimal control simulations of reaching movements." _Journal of neurophysiology_ 133, no. 4 (2025): 1266-1278.<br><br>
77

88
# Usage Instructions
9-
Get started using the [example walkthrough](https://github.com/Al-Borno-Lab/mousearm/blob/main/example.md). Or, start with the demo below.
10-
9+
Get started using the [example walkthrough](https://github.com/Al-Borno-Lab/mousearm/blob/main/example.md). Or, start with the demo below.<br><br>
1110

1211
# Demo
1312

@@ -46,6 +45,7 @@ To do this, run:
4645
cd mousearm/Demo
4746
python demo.py
4847
```
48+
<br>
4949

5050
# Sample Usage
5151

@@ -65,6 +65,7 @@ from mousearm.simulate import run_simulation
6565
run_simulation("Data", nReachSets=2) # Adjust nReachSets accordingly
6666
```
6767
Then, run it using `python run ` from the parent directory of the Data folder.
68+
<br><br>
6869

6970
# Data Formatting
7071
Process the motion capture data through [DeepLabCut](https://github.com/DeepLabCut/DeepLabCut). The output file will have more data than necessary, so delete everything except time, paw (x,y,z), wrist (x,y,z), shoulder (x,y,z), elbow (x,y,z). At the end, the csv file should look like the following:
@@ -80,6 +81,7 @@ RawData/
8081
│ └── kinematics_1.csv
8182
└── ...
8283
```
84+
<br>
8385

8486
# Output File Processing
8587

0 commit comments

Comments
 (0)