GUI to load and analyze image data from electrical impedance tomography (EIT)
Project description
EIT Dashboard
Visualize and manipulate EIT in a code free way using the open source eitprocessing software.
Important: While the software code is open source, your data may not be. Once the dashboard is downloaded (and/or updated) on your local machine, no online interaction is needed. Your data remains local and is not shared or uploaded by this software.
| Badges | |
|---|---|
| code repository |  |
| license |  |
| community registry |   |
| howfairis |  |
| Documentation |  |
Getting started
Install EIT Dashboard
The first time that the dashboard is used, the repository needs to be cloned and the package has to be installed as follows:
- Create fresh environment
- Make sure you are in your base environment:
conda activate - Create a new environment:
conda create -n <envname> python=3.10 - Activate new environment:
conda activate <envname>
- Make sure you are in your base environment:
- Clone and install
- Clone the repository:
git clone git@github.com:EIT-ALIVE/eit_dash.git - Install:
- Run
pip install -e .
- Run
- Clone the repository:
2. Running EIT Dashboard
To run the installed dashboard the following command can be used:
eit-dash run
Open the resulting link in a browser (often something like http://127.0.0.1:8050/).
Note that while the dashboard should work on any browser, if you are experiencing issues we recommend switching to
Chrome or Firefox, as these are the browser where we do most of the testing.
Please see our user manual for instructions on how to use the dashboard.
For developers
1. Installation
Install Poetry
EIT Dashboard uses of poetry to easily manage the needed packages. Poetry can be installed as follows. Please refer to the official installation instructions if problems arise:
In Linux (and WSL) or macOS
curl -sSL https://install.python-poetry.org | python3 -
Alternatively, you can use Homebrew in macOS:
brew install poetry
In Windows (using PowerShell)
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
Alternatively, poetry can also be installed using pip or conda in a virtual environment of choice.
Install EIT Dashboard
The first time that the dashboard is used, the repository needs to be cloned and the needed dependencies have to be installed by navigating to the path where it should be installed and running:
git clone git@github.com:EIT-ALIVE/eit_dash.git
cd eit_dash
poetry install
2. Running EIT Dashboard
Stay up to date
To ensure you are using the newest version, including any updates since you last used it, navigate to the folder where the dashboard is installed and run:
git pull
poetry install
Run dashboard
Run the command below to run the dashboard with the latest change made in the code, and follow the link displayed.
poetry run python eit_dash/main.py
Documentation
Include a link to your project's full documentation here.
Contributing
If you want to contribute to the development of eit_dash, have a look at the contribution guidelines.
Credits
This package was created with Cookiecutter and the NLeSC/python-template.
License
This source code is licensed using a standard Apache 2.0 License
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
