{"id":13422204,"url":"https://github.com/OpenEIT/OpenEIT","last_synced_at":"2025-03-15T11:31:22.233Z","repository":{"id":40775503,"uuid":"111727039","full_name":"OpenEIT/OpenEIT","owner":"OpenEIT","description":"Python based dashboard for real-time Electrical Impedance Tomography including image reconstruction using Back Projection, Graz Consensus and Gauss Newton methods","archived":false,"fork":false,"pushed_at":"2023-07-06T21:33:20.000Z","size":197022,"stargazers_count":218,"open_issues_count":14,"forks_count":71,"subscribers_count":27,"default_branch":"master","last_synced_at":"2024-10-27T22:33:09.364Z","etag":null,"topics":["biomedical-image-processing","biomedical-instrumentation","eit","electrical-impedance-tomography","image-reconstruction","inverse-problems","python","tomography"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenEIT.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-11-22T20:00:30.000Z","updated_at":"2024-10-21T17:37:59.000Z","dependencies_parsed_at":"2022-08-10T00:41:25.547Z","dependency_job_id":"4c70087a-3134-45ac-b7cb-a2b1a9fc2f30","html_url":"https://github.com/OpenEIT/OpenEIT","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenEIT%2FOpenEIT","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenEIT%2FOpenEIT/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenEIT%2FOpenEIT/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenEIT%2FOpenEIT/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenEIT","download_url":"https://codeload.github.com/OpenEIT/OpenEIT/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243724948,"owners_count":20337654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["biomedical-image-processing","biomedical-instrumentation","eit","electrical-impedance-tomography","image-reconstruction","inverse-problems","python","tomography"],"created_at":"2024-07-30T23:00:39.108Z","updated_at":"2025-03-15T11:31:21.572Z","avatar_url":"https://github.com/OpenEIT.png","language":"Python","funding_links":[],"categories":["Fantastic Applications"],"sub_categories":[],"readme":"# OpenEIT Dashboard\n\nBiomedical Imaging has previously been expensive and near impossible to hack and experiment with. If more people experimented and understood how imaging works we could move it forward much faster and make these transformative technologies available to everyone. OpenEIT(EIT is for electrical impedance tomography) uses non-ionizing AC current to recreate an image of any conductive material, such as your lungs, arm or head, using the same tomographic reconstruction technique as a CATSCAN. The PCB is only 2\" square, with bluetooth, making it a portable and hackable way to do biomedical imaging!\n\n## NOTE FOR WINDOWS USERS\nSPECTRA uses an FTDI chip to communicate via UART. The VCP FTDI driver is not pre-installed on Windows(but is on all other OS's). If you are running a Windows machine you should follow these instructions to install the FTDI driver before continuing to the dashboard install: https://www.ftdichip.com/Drivers/VCP.htm\n\n\n##  How to install the python dashboard. \n\n## Requirements\n```\nPython 3.6.7 \n```\n\n## Install\n```\npip install -r requirements.txt\n\n```\nIf you have any problems, it's likely that the requirements installation didn't complete, and you have incorrect versions of the modules installed. The following command will check the version of a single module, and you should check each module to ensure it is the same as listed in the requirements.txt file. \n\n```\npip show \u003cpackage_name\u003e\n\n```\n\nAlternatively you can run the following command to get a list of all installed modules. Before creating an issue in this repository regarding the installation process, check each version in the requirements.txt against your installed version. They should match! \n\n```\npip freeze\n\n```\n\nYou can also install in a virtual environment following the directions below, which means any other python modules you have installed remain the same, and the EIT project will be in a separate sandbox. \n\n```\nvirtualenv -p python3 envtest\n\nsource envtest/bin/activate\n\ngit clone https://github.com/OpenEIT/OpenEIT.git\n\ncd OpenEIT\n\npip install -r requirements.txt\n\npython app.py \n```\n\n## Make sure the button is in the 'ON' position. \n\nPlug in your microUSB cable if using with serial, then make sure that switch is turned on. Bluetooth and serial comms should now be active. \n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"images/on_switch.png\" height=\"300\"\u003e\n\u003c/p\u003e\n\n\n## Run\n```\npython app.py\n```\nYou should now see the server running through the console at a server location accessible by any internet browser at Running on http://127.0.0.1:8050/. To see the dashboard open a browser window(I use chrome) to this address.\n\nThe dashboard should now be open and running and look like this: \n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"images/software.png\" height=\"400\"\u003e\n\u003c/p\u003e\n\n## Functionality \n\nThe dashboard can connect to the SPECTRA device via Bluetooth or Serial connection, do tomographic reconstructions in real-time, or by reading in offline data. You can also record data for later analysis. We suggest you have a look in the tutorials to try time series, bioimpedance spectroscopy and electrical impedance tomography functionality. [Tutorials](https://openeitgithubio.readthedocs.io/en/latest/)\n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"images/eit32.jpeg\" height=\"300\"\u003e\n\u003c/p\u003e\n\n\nIn the root OpenEIT folder there are a couple of extra scripts which are helpful when doing analysis. \n\n# offline.py \n\nIs an example of how to read in offline data for analysis outside the dashboard. It will read in a file created by simdata.py, or one that is saved by the dashboard. Read through this file, and modify it for your own application. This is an example, and do note that algorithms can be tuned and optimized. You can look at the pyEIT documentation to find more details on this. \n\n```\npython offline.py\n\n```\n\n# simdata.py \n\nSimdata creates data in the same format as the hardware device, incase you want to do simulations before collecting real data. Simdata currently appends data to the simdata.txt file. Do note, that if you change parameters for recording, you should remove the pre-exisitng simdata file, so the data contained in it is all of the same format. \n\nExample usage:\n\n```\npython simdata.py\n\n```\n\nOutputs a simdata.txt file in the same format as the EIT dashboard. \n\nYou can also use the main software to do either time series or bioimpedance spectroscopy. Instructions for these can be found in the readthedocs tutorials. \n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"images/LungscomparedtoCTScan.png\" height=\"300\"\u003e\n\u003c/p\u003e\n\n## Algorithms \n\nThere are three classic EIT algorithms implemented - Back Projection, Graz Consensus and Gauss Newton Methods using the pyEIT toolbox - [pyEIT](https://github.com/liubenyuan/pyEIT). Each has many parameters which can be adjusted to get better results. It's also possible to create 3D meshes with this software in a similar manner to EIDORS(a matlab based EIT software suite). \n\n## License \n\nThe Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License seems to fit best with this project. Basically your'e liable to keep any derivative works open, and if you want to do a private fork for a commercial application please contact us and pay a small fee(which goes towards the open source project next revision) either in cash or equity in your company. Check out the human readable summary here: \n\n\u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc-sa/4.0/\"\u003e\u003cimg alt=\"Creative Commons License\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png\" /\u003e\u003c/a\u003e\u003cbr /\u003eThis work is licensed under a \u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc-sa/4.0/\"\u003eCreative Commons Attribution-NonCommercial-ShareAlike 4.0 International License\u003c/a\u003e.\n\nIf you'd like to make a derivative of this project in a commercial setting, we'd love a payment in exchange for a commercial license so that we can afford to spend time both maintaining this project and making more projects like this one. If this hybrid open source model works, it would enable open source projects to receive some funding, making the global commons stronger to benefit everyone. \n\n## Donate! \nAre you using this effort? Is it helpful to you? Would you like to see it maintained, updated and perhaps a new iteration come out sometime? This project has taken a lot of time and effort! The best way to keep it going is to donate. \n\n\u003ca class=\"dbox-donation-button\" href=\"https://donorbox.org/donate-to-make-biomedical-imaging-more-accessible?hide_donation_meter=true\" style=\"background:#2d81c5 url(https://d1iczxrky3cnb2.cloudfront.net/red_logo.png) no-repeat 56px center; color: #fff;text-decoration: none;font-family: Verdana,sans-serif;display: inline-block;font-size: 16px;padding: 17px 64px 17px 94px; -webkit-border-radius: 4px; -moz-border-radius: 4px; border-radius: 4px; box-shadow: 0 2px 0 0 #1f5a89; text-shadow: 0 1px rgba(0, 0, 0, 0.3);\" \u003e\u003cimg src=\"images/button-medium-blue.png\"\u003e\u003c/a\u003e\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenEIT%2FOpenEIT","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOpenEIT%2FOpenEIT","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenEIT%2FOpenEIT/lists"}