Jointly: A Python Package for synchronizing multiple sensors with accelerometers

[enra64]

Submitting Author: Arne Herdick (@enra64)
All current maintainers: @enra64, @arianesasso
Package Name: Jointly
One-Line Description of Package: Jointly is a python package for synchronizing sensors with accelerometer data
Repository Link: https://github.com/hpi-dhc/jointly
Version submitted: 1.0.2
Editor: @xmnlab
Reviewer 1: @AlexS12
Reviewer 2: @arthur-e
Archive:
JOSS DOI: N/A
Version accepted: 1.0.3
Date Accepted: 12/29/2021

---

Description

• Include a brief paragraph describing what your package does:

jointly is a python package for synchronizing devices that contain accelerometer sensors. For example, if you shake all your devices together before and after a study, jointly will find these shakes, remove any temporal offset between the sensors, and stretch the data so every clock aligns to a reference sensor. Jointly ingests and produces pandas' DataFrame objects.

Scope

• Please indicate which category or categories this package falls under:
  • Data retrieval
  • Data extraction
  • Data munging
  • Data deposition
  • Reproducibility
  • Geospatial
  • Education
  • Data visualization*

* Please fill out a pre-submission inquiry before submitting a data visualization package. For more info, see notes on categories of our guidebook.

• Explain how the and why the package falls under these categories (briefly, 1-2 sentences):
  This package was developed to synchronize multiple sensors together. Our usecase was to synchronize 6 IMUs to an ECG sensor with an IMU, all of which were worn by a participant during our study.

• Who is the target audience and what are scientific applications of this package?
  The target audience is fellow researchers trying to achieve high-quality synchronization for multiple study devices that also have an Accelerometer.

• Are there other Python packages that accomplish the same thing? If so, how does yours differ?

To our current knowledge, none exist.

• If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted:

Technical checks

For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:

• does not violate the Terms of Service of any service it interacts with.
• has an OSI approved license.
• contains a README with instructions for installing the development version.
• includes documentation with examples for all functions.
• contains a vignette with examples of its essential functions and uses.
• has a test suite.
• has continuous integration, such as Travis CI, AppVeyor, CircleCI, and/or others.

Publication options

• Do you wish to automatically submit to the Journal of Open Source Software? If so:

JOSS Checks

• The package has an obvious research application according to JOSS's definition in their submission requirements. Be aware that completing the pyOpenSci review process does not guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS.
• The package is not a "minor utility" as defined by JOSS's submission requirements: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria.
• The package contains a paper.md matching JOSS's requirements with a high-level description in the package root or in inst/.
• The package is deposited in a long-term repository with the DOI:

Note: Do not submit your package separately to JOSS

Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?

This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.

• Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review.

Code of conduct

• I agree to abide by pyOpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.

P.S. *Have feedback/comments about our review process? Leave a comment here

Editor and Review Templates

Editor and review templates can be found here

[lwasser]

hey there @enra64 !! thank you for this submission! we will review it and get back to you with next steps. Welcome to pyopensci!

[enra64]

Thank you 🙂

[lwasser]

hi @enra64 @xmnlab will serve as your fearless editor for this submission... more from them soon!

[xmnlab]

@enra64 thank you for submitting your package to PyOpenSci!
I will start to check some points today and I will keep you updated here :)

[enra64]

Thanks @xmnlab and @lwasser, looking forward to it :)

[xmnlab]

Editor checks:

• Fit: The package meets criteria for fit and overlap.
• Automated tests: Package has a testing suite and is tested via Travis-CI or another CI service.
  • GitHub Actions
• Documentation: Package has documentation setup (ReadTheDocs, JupyterBook, website,etc.).
  • https://jointly.readthedocs.io/
• License: The package has an OSI accepted license
  • - MIT
• Repository: The repository link resolves correctly
• Archive (JOSS only, may be post-review): The repository DOI resolves correctly
• Version (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?

---

Editor comments

Thank you @enra64 for submitting your project to PyOpenSci! I have some experience with data acquisition and I am very happy to be acting here as editor.

Do you have any suggestion for a reviewer? We often select one reviewer suggested by the package's author and another one will be selected by us. If you don't have any suggestion then I will look for two.

Thank you so much!

---

Reviewers: Alejandro Sáez Mollejo (@AlexS12) and Arthur Endsley (@arthur-e)
Due date: 2021-12-13

[xmnlab]

@AlexS12 as we talked some days ago, we are very happy to have you here reviewing Jointly. thank you!

The PyOpenSci contributing guide is here https://www.pyopensci.org/contributing-guide/intro.html and this is the guide specifically for reviewers: https://www.pyopensci.org/contributing-guide/open-source-software-submissions/reviewer-guide.html

Feel free to ping me anytime when you need any information or help.

I am waiting for the confirmation of one more reviewer and after that, I will update the schedules for this review.

thank you so much for your support :)

[xmnlab]

@enra64 not sure if you were able to check my comment here: #45 (comment).

We often select one reviewer suggested by the package's author and another one will be selected by us. If you don't have any suggestions then I will look for another one. Thank you so much.

[enra64]

Hey, sorry, I forgot about it. I have to say that I don't have a suggested reviewer.

[xmnlab]

no worries at all! So, I will search for one more and I will keep you updated about that. thanks