Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Movement Analysis Code for Everyone #54

Open
14 of 16 tasks
dblana opened this issue Jan 22, 2019 · 19 comments
Open
14 of 16 tasks

Movement Analysis Code for Everyone #54

dblana opened this issue Jan 22, 2019 · 19 comments

Comments

@dblana
Copy link

dblana commented Jan 22, 2019

Project Lead:
dblana

Mentor:
ottagit

Welcome to OL7, Cohort C! This issue will be used to track your project and progress during the program. Please use this checklist over the next few weeks as you start Open Leadership Training 🎉.


Before Week 1 (Jan 30): Your first mentorship call

  • Complete the OLF self-assessment (online, printable). If you're a group, each teammate should complete this assessment individually. This is here to help you set your own personal goals during the program. No need to share your results, but be ready to share your thoughts with your mentor.
  • Make sure you know when and how you'll be meeting with your mentor.

Before Week 2 (Feb 6): First Cohort Call (Open by Design)

Before Week 3 (Feb 13): Mentorship call

  • Look up two other projects and comment on their issues with feedback on their vision statement.
  • Complete your Open Canvas (instructions, canvas). Comment on this issue with a link to your canvas.
  • Start your Roadmap. Comment on this issue with your draft Roadmap.

Before Week 4 (Feb 20): Cohort Call (Build for Understanding)

  • Look up two other projects and comment on their issues with feedback on their open canvas.
  • Pick an open license for the work you're doing during the program.
  • Use your canvas to start writing a README, or landing page, for your project. Link to your README in a comment on this issue.

Week 5 and more

This issue is here to help you keep track of work as you start Open Leaders. Please refer to the OL7 Syllabus for more detailed weekly notes and assignments past week 4.

@dblana
Copy link
Author

dblana commented Feb 4, 2019

Draft mission statement: I am working with clinicians and researchers in motion analysis labs to share coding resources, so that they can improve and accelerate their analyses.

@dblana
Copy link
Author

dblana commented Feb 10, 2019

Open Canvas

@dblana
Copy link
Author

dblana commented Feb 10, 2019

Roadmap

The use of computer code can greatly benefit clinical movement analysis. It can save time and reduce errors by automating routine tasks, and it can produce new insights by enabling complex calculations. However, not everyone has the skills or time to learn how to develop their own code.

We are proposing to develop a free online platform for sharing code, which will also include step-by-step tutorials on how to develop and use it. People with technical skills will be able to collaborate, create new tools, and easily share them among all motion analysis labs. Beginners who are keen to develop coding skills will find a library of tutorials and example code to support their learning. Researchers and clinicians working on motion analysis who would like to use code but do not have time or interest in developing it themselves, will be able to easily find relevant resources, with instructions and examples of use.

Milestone: Clinical Movement Analysis Society (CMAS) annual meeting
It would be great to have a website by the CMAS annual meeting, April 25-26 2019!

  • Create github repository
  • Add readme
  • Add code of conduct
  • Add contributor guidelines
  • Add FAQ

Milestone: Example code
The example code we will provide initially will be in Python and focus on how to work with C3D files (the de facto standard for movement analysis data).

  • Add Python code to extract different types of information from C3D files and visualise it
  • Add tutorial to explain the code
  • Add a ready-to-use application: Python code to calculate the gait profile score and movement analysis profile

Milestone: Workshop for CMAS labs
We will have a one-day coding workshop for UK CMAS labs (sometime in the summer 2019). We already have funding for one travel grant per CMAS-accredited lab, to encourage participation from as many members of the CMAS community as possible.

  • Arrange speakers
  • Create workshop material

@dblana dblana mentioned this issue Feb 10, 2019
16 tasks
@annefou
Copy link

annefou commented Feb 11, 2019

Nice roadmap. I still need to finalize mine... I think I'll steal your idea to have a workshop as a milestone! That's a very motivating target!

@ottagit
Copy link

ottagit commented Feb 11, 2019

@dblana Good job on both your open canvas and project roadmap; I like the clarity and precision of the former, and just enough detail provided in the roadmap at this stage of the project. Thanks @annefou for your feedback. Hope to see more interactions on this issue 👍 👍

@mrpandey
Copy link

That's a good mission statement - clear and concise. And that's an even better roadmap! I am looking forward to contribute if my skill-set matches the requirements.

@ottagit
Copy link

ottagit commented Feb 12, 2019

@mrpandey many thanks for your feedback. Would be glad to have you on board @dblana

@theo-bech
Copy link

Very concise vision statement, and a great project overall! Agree with @annefou, the workshop as a milestone is an excellent idea.

@balicea
Copy link

balicea commented Feb 18, 2019

Mission statement is very to the point. A few clarifications:

  1. under "key metrics": what's more important in terms of code shared, quality or quantity? Are there annotation or formatting standards that the community must meet?

  2. under "solution": will your tutorials be stylized as a Wiki, a set of YouTube videos, or as a more standard technical doc? What is most accessible to your community?

@dblana
Copy link
Author

dblana commented Feb 19, 2019

Mission statement is very to the point. A few clarifications:

  1. under "key metrics": what's more important in terms of code shared, quality or quantity? Are there annotation or formatting standards that the community must meet?
  2. under "solution": will your tutorials be stylized as a Wiki, a set of YouTube videos, or as a more standard technical doc? What is most accessible to your community?

These are excellent points! 😃

  1. On quality vs quantity: I am keen to get as many people involved as possible, and most of them do not have any formal computer science training... so I guess quantity is more important. But we should include guidelines for writing good software that can be shared, thank you for pointing that out!

  2. My thought was that the tutorials would be simple documents, because I don't know how to make YouTube videos myself - but other contributors might! I will add that to the list of ways people can contribute 👍

@dblana
Copy link
Author

dblana commented Feb 19, 2019

Busy week, but I managed to make a repository for the project, and started the README.md file. A lot of construction signs 🚧 everywhere...

@annefou
Copy link

annefou commented Feb 19, 2019

Nice! I also created my README.md but should definitely use this construction sign 🚧 (Thanks I did not know it!!!) to show it is not finalized.

@dblana
Copy link
Author

dblana commented Feb 19, 2019

So many emojis... https://gist.github.com/rxaviers/7360908

@annefou
Copy link

annefou commented Feb 19, 2019

👏 So cool!!! Thanks for sharing!

@theo-bech
Copy link

A very clear open canvas, it helped me figure out how to make mine more comprehensive!

@scottkildall
Copy link

Wow, good work here. At first I got a little tripped up in the specifics, e.g. does "clinical movement analysis" mean? Then, when reading more deeply, it's all there. So, perhaps an example in the ReadMe for a more general audience, if you want to serve that community (which is where you're getting feedback) would be helpful. Thanks!

@dblana
Copy link
Author

dblana commented Feb 26, 2019

Wow, good work here. At first I got a little tripped up in the specifics, e.g. does "clinical movement analysis" mean? Then, when reading more deeply, it's all there. So, perhaps an example in the ReadMe for a more general audience, if you want to serve that community (which is where you're getting feedback) would be helpful. Thanks!

Thank you! That's a great idea 👍

@dblana
Copy link
Author

dblana commented Feb 27, 2019

@scottkildall As I am learning how github works, I added your suggestion as the first issue: https://github.com/cmasuki/open-code/issues

@dblana
Copy link
Author

dblana commented Mar 6, 2019

I updated the contributing guidelines and I'd love some feedback! I've tried to make it easy enough for beginners, but not too long... Is there sufficient information there to get people started? How much info should I provide about Git? 😬 Any comments/suggestions would be greatly appreciated! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

8 participants