Code Monkey home page Code Monkey logo

echopen_prototyping's Introduction

AN OPEN SOURCE AND COMMUNITY-BASED PROJECT

echOpen is an open and collaborative project and community, led by a multidisciplinary core of experts and senior professionals with the aim of designing a functional low-cost (affordable) and open source echo-stethoscope (ultrasound probe) connected to a smartphone, allowing the radical transformation of diagnostic orientation in hospitals, general medicine and medically underserved areas. This initiate is aimed for health professionals from southern and northern countries.

JOINING THE PROJECT

If you wish to join this community, this guide can help you understand the project and its main goals. With this guide, we aim to accompany you to contribute to the echOpen project (by installing your own hardware kit and/or your dev environement with the support of the expertise and experience of the echOpen community).

Enjoy your reading !

echOpen community

For more details, please visit echopen.org and join us on Slack, Facebook and Twitter.

Illustrations for echOpen CC BY NC ND: Drawings by Barbara Govin / Storyboard by Ermete Mariani

echopen_prototyping's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

echopen_prototyping's Issues

Write documentation for software

Write full documentation for the android app being released with version 3.0.0 :

  • architecture scheme
  • rendering pipeline
  • link to code documentation ?

Indicative due date : April 10th, 2017

Criteria to close the issue :

Write an assembly guide

From the draft (word document) and images available for download in this issue, write a comprehensive assembly guide (in markdown) for 3.0.0 release.

Indicative due date : April 30th, 2017

Criteria to close the issue :

Preliminary version of the files :

guide_montage.zip

Beta-test the gitbook :D

Read the brand new gitbook and give us some feedbacks ! ttps://echopen.gitbooks.io/echopen_prototyping/content/

Indicative due date : June 30th, 2017

Criteria to close the issue :

remake static documentation website

Update the static documentation website with the configuration of release 3.0.0

Indicative due date : May 25th, 2017

Criteria to close the issue :

  • Comment this issue with a link to the updated website

Highlight contributors on the gitbook

Highlight contributors on the gitbook:

  • 1 dedicated page with all contributor's name at the beginning of the gitbook
  • ask to each contributors how they want to be called, and to which sections/pages they contributed
    --> write the contributors' names at the beginning of each section or page

Indicative due date : July 11th, 2017

Criteria to close the issue :

Complete the "HETIC challenge" section

Complete the file describing HETIC School challenge.

Indicative due date : June 23th, 2017

Criteria to close the issue :

  • fork the repo
  • edit the file challenges/hetic-school-challenge.md
  • if you want to include images and so on, please put the additional files in challenges/picture/ folder
  • make a pull request refering to this issue

Finish merging content from the android app gitbook

Find where to merge remaining contents from the android app gitbook. Below are listed the files that are not yet (fully) included in the new gitbook :

  • algorithms/scan-conversion.md : "Presentation of the scan conversion" has been moved to the introduction. "Current algo choice" has to be merged somewhere.
  • challenges/mockup-ux/mockups-v1.md will be merged into the future iteration planning
  • configuring-your-own-dataset.md
  • constants.md
  • install-opencv-v-20.md
  • playing-with-data.md

Indicative due date : June 15th, 2017

Criteria to close the issue :

  • To edit the gitbook, clone the repo : https://github.com/echopen/echopen_prototyping
  • Edit some markdown files to merge the contents
  • The old versions of the hacking guide are in the hacking-guide/ directory
    Make a pull request refering to this issue

Write documentation for hardware

Write full documentation for the version 3.0.0 prototype :

  • updated block diagram
  • synoptic diagram representing the modules (with clear references to modules + links to the github documentation of each module) and connections between them (direction of the signal transmission should be indicated)
  • check that all the module descriptions are up-to-date and complete
  • write an explicit description of the configuration, including the exhaustive description of the "default" tunings on each module (gain, ADC frequency, motor control...)
  • mechanical scheme + description of the functioning
  • characteristics of transducer
  • link to the complete kit configuration in the PRJ_medtech-kit repo (the new prototype has to be created in the repo)

Indicative due date : April 10th, 2017

Criteria to close the issue :

Write a bibliography about denoising

Gather information about denoising applied to ultrasound imaging.

Indicative due date : July 30th, 2017

Criteria to close the issue :

  • fork the repo
  • edit literature.bib with your references (.bib files can be handled for example with bibDesk on macOsX)
  • edit the file references/sigproc/Denoising.md with a summary of your findings. In this file you'll be able to cite references from literature.bib by calling : {{ "some-key" | cite }} where some-key has to be replaced by the cite key from literature.bib (you can inspire yourself from references/sigproc/IMGQ_metrics.md to understand how citations work)
  • if you use latex formulas, please put these between DOUBLE $$ : $$\sigma$$ for example
  • if you use latex formulas, please check the compatibility with the gitbook's plugin BEFORE making a pull request. A useful link for this : https://khan.github.io/KaTeX/
  • make a pull request refering to this issue

Write a benchmark of similar devices

Gather information about similar devices.

Indicative due date : July 30th, 2017

Criteria to close the issue :

  • fork the repo
  • edit the file references/benchmark/benchmark_1.md with a summary of your findings.
  • if you want to benchmark more devices, just create benchmark_2.md etc... in references/benchmark/ and add them in the SUMMARY.md
  • make a pull request refering to this issue

Draw a global block diagram (hardware + software)

Draw a global block diagram displaying the hardware + software functions, and explicit the data transfer protocol

Indicative due date : April 10th, 2017

Criteria to close the issue :

Merge "hacking guide" parts in the suited sections of the gitbook

Let's :

  1. Create a "get started" section with two sub-sections ("Hacking guide" + "set up you echOpen lab" from the starterkit) here "hacking guide" should gather only the information that is necessary to install the "dev" version of the app (?)
  2. Dispatch the information from the "old" hacking guide to the best suited sections :
  • installation, running the app, echopen's virtual machine should go to "stable release/installing the app"
  • mockup - UX will be a task for next iteration (this has to be written in the "preparing captech" file)
  • the other challenges should be re-structured so that contributors can easily take part --> those ones will go in the dedicated "challenges" section
  • "scan conversion" should be splitted into a pedagogical part that will be integrated in the technical introduction, and an app-related part that should go in the documentation

Indicative due date : June 1st, 2017

Criteria to close the issue :

Rewrite introduction

Write an educational introduction about ultrasound imaging, basic acoustics and technics

Indicative due date : April 30th, 2017

Criteria to close the issue :

Complete the "device characteristics section" for stable version

Make a short summary of the device characteristics :

  • recall the default tunings of the device
  • depth of detection, angular coverage
  • SNR
  • number of pixels, size of pixels, framerate
  • add some figures (visualizing the signal envelope + images from the device)

Indicative due date : April 10th, 2017

Criteria to close the issue :

Mobile App documentation upgrade

Here a list of all issues:

  • Clean Minute of meetings

  • change GPU & real time processing challenge in order to get a more general challenge(multi filters, multi techno)

  • close challenge - Scan conversion,
    fix typo

  • migrate data format challenge to DICOMIZER challenge

  • fill HETIC School challenge

  • create new cards in Mobile app Projects v4.0.0

  • reorganize Mockup page

  • finalize rendering pipeline with data stream quantification

  • move "Current algo choice for scan-conversion" to another section "Technical choice"

issue from Beta testing ->
in stable/requirements/specifications/mobile-app.md:
-- "... today, the frame-rate is 5 frames per second (fps)": I'm confused. Previous mentions were 2fps, then 90-100 (but only on mobile app, if I understand correctly). What is the currently achieved framerate ? Also, the last sentence, "In the current hardware configuration" is hanging without an end.
-- " -> clement for more details" this could be explicited with a @ , no ?

in stable/requirements/UX_design:
-- we open on an empty page again.
-- it looks like this is closely related to the previous section, right ?
-- images are HUGE ๐Ÿ˜„

in stable/doc_pipeline.md:
-- the words in each block are cropped, but that could also be because of my browser ...

Write a reference document for the leaderboard

Write a reference document for the leaderboard

Indicative due date : July 30th, 2017

Criteria to close the issue :

  • fork the repo
  • edit the file references/sigproc/leaderboard.md
  • if you use latex formulas, please check the compatibility with the gitbook's plugin BEFORE making a pull request. A useful link for this : https://khan.github.io/KaTeX/
  • make a pull request refering to this issue

Write a synthetic document about IQ demodulation / Hilbert transform

Gather information about IQ demodulation / Hilbert transform.

Indicative due date : June 1st, 2017

Criteria to close the issue :

  • fork the repo
  • edit literature.bib with your references (.bib files can be handled for example with bibDesk on macOsX)
  • edit the file references/sigproc/envelope_extraction.md with a summary of your findings. In this file you'll be able to cite references from literature.bib by calling : {{ "some-key" | cite }} where some-key has to be replaced by the cite key from literature.bib (you can inspire yourself from references/sigproc/IMGQ_metrics.md to understand how citations work)
  • make a pull request refering to this issue

Bibliography : How to assess the image quality

Gather information about state-of-the-art ways of assessing the quality of an ultrasound image.

Indicative due date : April 30th, 2017

Criteria to close the issue :

  • identify a set of metrics that will be used to evaluate the image quality of the echOpen kit
  • gather clear instructions about how to measure those metrics : needs for phantom, measurement technics, ...
  • write a summary of the findings and include it in the prototyping gitbook.
  • make a pull request refering to this issue

Some bibliography has already been carried out. You can find the references here : https://drive.google.com/drive/folders/0B8YU5qFDi1mDX2hnazlpTl9uSms

complete references about mechanical issues

Gather information about mechanical issues.

Indicative due date : May 25th, 2017

Criteria to close the issue :

  • fork the repo
  • edit the file references/mechanics/mechanical_issues.md with a summary of your findings.
  • make a pull request refering to this issue

Generate automatically a shared bibliography with bibtex + a script

Create a shared bibliography with bibtex.
Use https://plugins.gitbook.com/plugin/bibtex

Indicative due date : May 30th, 2017

Criteria to close the issue :

  • Fork the repo : https://github.com/echopen/echopen_prototyping
  • In the "References/sigproc" subdirectory, create a .bib file containing the references from the file References/sigproc/IMGQ_biblio.md
  • Use the bibtex plugin to generate a table of references to replace the content of IMGQ_biblio.md
  • Edit References/sigproc/IMGQ_metrics.md to cite the references from the .bib file.
  • In the "References" subdirectory, write a script that allows to generate the .md files from the bibtex
  • Make a pull request refering to this issue

Prepare next CapTech

Let's gather ideas of improvements to be done during next iteration !
We created a dedicated page in the gitbook that everyone can feed with ideas that will be discussed during next CapTech.

Indicative due date : June 1st, 2017

Criteria to close the issue :

Update the prototyping gitbook (https://echopen.gitbooks.io/echopen_prototyping/) with the ideas that you want to propose to improve the echOpen device ;-)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.