Doppler Segmentations

These codes make up the framework for segmenting the doppler ultrasound scans.

Installation

To install as a dependency for your project:

pip install usseg

or

poetry add usseg

Development Environment

To install the development environment follow the following steps:

  • Clone this repository and change into the directory.

  • Install poetry as per the installation instructions.

  • Install tesseract as per the installation instructions. - Note that the project has only been tested with tesseract version 5.

  • Install the package dependencies with:

poetry install

  • Enter into the development shell with:

poetry shell

  • You are now in the development environment!

  • Copy config_example.toml to config.toml and change the variables for your local set up (e.g., path to your data, etc.).

  • The main script can now be run in one complete run with:

python usseg/main.py

  • If debugging in VSCode, ensure the Python interpreter is set to the virtual environment created by poetry. This path can be found using:

poetry env info --path