Merge pull request #10 from Ipuch/hf

horizontal flexion alignement

.github/workflows/run_tests.yml

@@ -1,6 +1,10 @@
 name: Run the tests
 
-on: [pull_request]
+on:
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
 jobs:
   build:
     strategy:

README.md

@@ -328,3 +328,31 @@ The conversion process in this case is as follows:
 {}^{Euler}\mathbf{t}_D
 ```
 
+# Launch the streamlit app
+Download this repository and, install the dependencies on your python env:
+
+```bash
+pip install -r requirements.txt
+```
+or with conda:
+```bash
+conda install --file requirements.txt -c conda-forge
+```
+
+Then launch the streamlit app, from your terminal too:
+
+```bash
+streamlit run app_streamlit.py
+```
+
+Then you should get a interface like this that opens in your browser, so that you can navigate through the data:
+
+[Video to be uploaded]
+
+# 💡 Ways to Contribute
+- Data Contributions: If you have access to new datasets or corrections for existing data, please submit them. 
+Ensure they adhere to the expected format (refer to the Dataset Columns section in the README for details).
+- Feature Suggestions: Open an issue to suggest improvements or new features for the app or dataset processing.
+- Bug Reports: If you encounter an issue, open an issue in the repository and provide as much detail as possible (e.g., steps to reproduce, environment, error messages).
+- Documentation: Help us expand and improve the documentation. Clearer instructions and better examples are always welcome.
+

environment.yml

@@ -14,4 +14,5 @@ dependencies:
 - scipy
 - colorcet
 - seaborn
+- streamlit
 

examples/second_example.py

@@ -1,20 +1,20 @@
 from pandas import DataFrame
 
-from spartacus import DataFolder, load_subdataset, DataFrameInterface, DataPlanchePlotting
+from spartacus import DataFolder, Spartacus, DataFrameInterface, DataPlanchePlotting
 
 
 def main():
     # spartacus_dataset = load_subdataset(name=DataFolder.BEGON_2014, shoulder=1, mvt="sagittal plane elevation")
     # spartacus_dataset = load_subdataset(name=DataFolder.BEGON_2014)
-    spartacus_dataset = load_subdataset(
-        name=DataFolder.MATSUKI_2011,
-        mvt="scapular plane elevation",
-        # shoulder=1,
+    spartacus_dataset = Spartacus.load(
+        datasets=[DataFolder.OKI_2012, DataFolder.BOURNE_2003, DataFolder.MOISSENET],
+        mvt="horizontal flexion",
+        # shoulder=[i for i in range(1, 8)],
     )
-    # Extra 90 degre rotation for matsuki on last dof sternoclav ...
     print(spartacus_dataset.confident_data_values)
-    # return spartacus_dataset.corrected_confident_data_values
-    return spartacus_dataset.confident_data_values
+    return spartacus_dataset.corrected_confident_data_values
+    # if ones wants to return the uncompensated data:
+    # return spartacus_dataset.confident_data_values
 
 
 def plot_mvt(df: DataFrame):
@@ -24,7 +24,6 @@ def plot_mvt(df: DataFrame):
     for mvt in humeral_motions:
         sub_df = df[df["humeral_motion"] == mvt]
         dfi = DataFrameInterface(sub_df).rotational_interface()
-        plt = DataPlanchePlotting(dfi)
         plt = DataPlanchePlotting(dfi, restrict_to_joints=dfi.df["joint"].unique())
         plt.plot()
         plt.update_style()

requirements.txt

@@ -3,4 +3,5 @@ pandas>=2.0.0
 setuptools>=67.6.1
 biorbd>=1.9.9
 seaborn>=0.13.2
-dash>=2.15.0
+dash>=2.15.0
+streamlit>=1.1.0