openlifu is a toolbox for planning and controlling focused
ultrasound treatments. It generally replicates the functionality
developed in the MATLAB open-TFUS
toolbox.
Python 3.9 or later on Windows or Linux.
Windows:
C:\Users\<uname>\AppData\Local\Programs\Python\Python311\python.exe -m venv env
.\env\Scripts\activateLinux:
python3.11 -m venv envWith this repo as the working directory:
pip install -e .pip install -e '.[dev]'Data Version Control (DVC) is a data management tool that is meant to be run alongside Git.
In this project, DVC is used to link changes in the code to specific versions of a sample database containing example project files.
DVC can be used when this project is installed in Dev mode. You can read more about DVC and how to use it here.
Note: Remote access to the sample database stored on google drive is currently restricted. Access requires a gdrive_client_secret
for user access authentication to be shared by developers.
To download the sample database:
git pull
dvc remote modify --local shared_gdrive gdrive_client_secret <client_secret_here> # Contact developers for grive_client_secret
dvc pull # Requires access to remote storageThis will download a directory 'db_dvc' in the repo directory that contains the corresponding version of example database files.
To commit updates to the sample database:
dvc add db_dvc
git commit -m "Describe updates to database"
git push
dvc push #Requires access to remote storageCAUTION - Investigational device. Limited by Federal (or United States) law to investigational use. The system described here has not been evaluated by the FDA and is not designed for the treatment or diagnosis of any disease. It is provided AS-IS, with no warranties. User assumes all liability and responsibility for identifying and mitigating risks associated with using this software.