Metadata-Version: 2.4
Name: c3d-parser
Version: 0.1.8
Summary: C3D parser for gait data harmonisation.
Author-email: Timothy Salemink <tim.nicolas@outlook.com>, Sally Jack <sallyjaack@gmail.com>
License: 
           Copyright 2024 University of Auckland
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Repository, https://github.com/tsalemink/C3D-parser
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: c3d
Requires-Dist: trc-data-reader
Requires-Dist: opensim-model-creator
Requires-Dist: PySide6
Requires-Dist: matplotlib
Dynamic: license-file

# C3D-parser

### Installing the Python package:

It is recommended that you create a new virtual environment before installing this package, to
avoid any potential dependency conflicts with the packages already installed in your Python
environment.

If you intend to use this package directly from your Python environment you will also need to
install the OpenSim Python distribution yourself. This can be installed using Conda, or by building
the Python bindings from source.

After activating your Python environment and installing OpenSim you can run
`pip install c3d-parser` to install the application. It can then be started by running the command
`c3d_parser`.

### Installing the Windows executable:

The latest release of the C3D-Parser also provides a Windows installer for setting up an executable
version of the application. Simply download and run _C3D-Parser-{release-version}.exe_ for any
release in the GitHub repository [_Releases_](https://github.com/tsalemink/C3D-parser/releases).

### Usage:

To process and analyse a session of gait data, simply select the local session directory using
the "Input" line-edit or associated directory chooser, then click "Parse Session".

The application will create an OpenSim model using the input data and will run IK and ID. The
results from IK and ID will be displayed in the "Kinematic" and "Kinetic" tabs respectively.
The user can select specific gait cycles and can choose to exclude them from the data that will
be uploaded to the database.

Once the "Upload" button is pressed, the user exclusions will be considered and the final output
files will be produced. All outputs are written to the user-defined output directory. Currently,
no files are actually uploaded to the gait harmonisation database.
