File tree Expand file tree Collapse file tree 1 file changed +16
-1
lines changed
Expand file tree Collapse file tree 1 file changed +16
-1
lines changed Original file line number Diff line number Diff line change @@ -3,7 +3,7 @@ Student: Wei Liao
33
44This repository contains the code accompanying the project paper “A Flexible Python Framework for Full-Wave Inversion in Ultrasound Tomography”.
55
6- Repository Structure
6+ # Content
77- ** UFWI:**
88 The main software package implementing the framework.
99- ** test:**
@@ -19,3 +19,18 @@ Repository Structure
1919 Uses breast phantom data simulated with k-Wave from the code repository of Ali et al.
2020 The dataset is included in the Releases section of this repository.
2121 For the time-domain example, the corresponding sound-speed field was resampled from this dataset.
22+
23+
24+ # Environment Setup
25+ To run the code locally, follow the steps below.
26+ 1 ) Get the code: download or clone this repository.
27+ 2 ) (Recommended) Create a clean Python environment
28+ 3 ) Install k-Wave-python:
29+ macOS requires system libraries first:
30+ ``` brew install fftw hdf5 zlib libomp ```
31+ Then install the Python package:
32+ ``` pip install k-Wave-python ```
33+ 4 ) Install project dependencies:
34+ ``` pip install -r requirements.txt ```
35+
36+
You can’t perform that action at this time.
0 commit comments