autogaita 0.1.0__tar.gz → 0.2.1__tar.gz

autogaita-0.2.1/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.1
+Name: autogaita
+Version: 0.2.1
+Summary: Automatic Gait Analysis in Python
+Home-page: https://github.com/mahan-hosseini/AutoGaitA/
+Author: Mahan Hosseini
+License: GPLv3
+Requires-Python: >=3.10
+Provides-Extra: dev
+License-File: LICENSE

{autogaita-0.1.0 → autogaita-0.2.1}/README.md

@@ -16,7 +16,7 @@
 
 ## Getting Started
 
-***Note!** Our documentation provides step-by-step walkthroughs of how to install autogaita for **[Windows](https://docs.google.com/document/d/1Y4wrrsjs0ybLDKPzE2LAatqPDq9jtwjIuk4M0jRZ3wE/edit#heading=h.28j6wu2vamre)** and **[Mac](https://docs.google.com/document/d/1Y4wrrsjs0ybLDKPzE2LAatqPDq9jtwjIuk4M0jRZ3wE/edit)***
+***Note!** [Our documentation](https://docs.google.com/document/d/1Y4wrrsjs0ybLDKPzE2LAatqPDq9jtwjIuk4M0jRZ3wE/edit?usp=sharing) provides step-by-step walkthroughs of how to install autogaita for **[Windows](https://docs.google.com/document/d/1Y4wrrsjs0ybLDKPzE2LAatqPDq9jtwjIuk4M0jRZ3wE/edit#heading=h.28j6wu2vamre)** and **[Mac](https://docs.google.com/document/d/1Y4wrrsjs0ybLDKPzE2LAatqPDq9jtwjIuk4M0jRZ3wE/edit)***
 
 It is strongly recommended that a separate virtual environment for AutoGaitA is created (note that the approach below creates the virtual environment to your current directory):
 
@@ -31,6 +31,8 @@ It is strongly recommended that a separate virtual environment for AutoGaitA is
 
 - Access the main user interface via `python -m autogaita`.
 
+- To update to the latest release (see the *Releases* panel on the right for the current version) activate your virtual environment & enter `pip install autogaita -U`. 
+
 ## Tutorials and Examples
 
 ### Video Walkthrough Tutorials
@@ -45,7 +47,7 @@ We provide an example dataset in the **example data** folder of this repository,
 ### Annotation Table Examples and Templates
 Annotation Table example and template files for *AutoGaitA_DLC* and *AutoGaitA_Simi* can be found in the [**annotation tables**](https://github.com/mahan-hosseini/AutoGaitA/tree/main/annotation%20tables) folder of this repository.
 
-Users are advised to read the ***important note*** of that folder, use the template to enter their data's timestamp information and to then compare the resulting table with our example to check formatting.
+Users are advised to read the ***important note*** of that folder, use the template to enter their data's timestamp information and to then compare the resulting table with our example to check formatting. Users working with ImageJ/FIJI are encouraged to check out the [AnnotationTable-Plugin](https://github.com/luca-flemming/AnnotationTable-Plugin) developed by our contributor Luca Flemming.
 
 ## Documentation
 
@@ -62,6 +64,9 @@ By default, *AutoGaitA DLC* and *AutoGaitA Simi* implement standard values for m
 - [Documentation - AutoGaitA DLC](https://docs.google.com/document/d/1Y4wrrsjs0ybLDKPzE2LAatqPDq9jtwjIuk4M0jRZ3wE/edit#heading=h.20bg7b7ymt0b)
 - [Documentation - AutoGaitA Simi](https://docs.google.com/document/d/1Y4wrrsjs0ybLDKPzE2LAatqPDq9jtwjIuk4M0jRZ3wE/edit#heading=h.uz61bpmua7qz)
 
+## Analysing other behaviours - AutoCyclA 🚴
+Even though AutoGaitA's main focus is to automate and standardise gait analyses, our toolbox can be used to automate the analyses of any rhythmic behaviour of interest. For a proof-of-principle demonstration and an introduction of the general workflow of such analyses, see **[AutoCyclA - Automated Cycling Analysis with AutoGaitA.](https://github.com/mahan-hosseini/AutoGaitA/tree/main/autocycla)**
+
 ## Reference
 If you use this code or data please [cite our preprint](https://www.biorxiv.org/content/10.1101/2024.04.14.589409v1).
 
@@ -71,4 +76,14 @@ AutoGaitA is licensed under [GPL v3.0](https://github.com/mahan-hosseini/AutoGai
 The AutoGaitA software is provided without warranty of any kind, express or implied, including, but not limited to, the implied warranty of fitness for a particular purpose.
 
 ## Authors
-Mahan Hosseini
+[Mahan Hosseini](https://github.com/mahan-hosseini)
+
+## Contributors
+[Luca Flemming](https://github.com/luca-flemming) - Undergraduate Student
+
+[Nicholas del Grosso](https://github.com/nickdelgrosso) - RSE Advisor
+
+## Contributing
+If you would like to contribute to the AutoGaitA toolbox, feel free to open a pull request or contact us at autogaita@fz-juelich.de! 
+
+We are looking forward to your input and ideas 😊