Skip to content

Commit df02b42

Browse files
authored
Merge pull request #50 from creatis-ULTIM/gbernardino-patch-1
Update README.md
2 parents 50f56c5 + 950c9a7 commit df02b42

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,24 @@ This is a Python reimplementation of the MUST ultrasound toolbox for synthetic i
66
As a design decision, we have tried to keep syntax as close as possible with the matlab version, specially regarding the way functions are called. This has resulted in non-pythonic arguments (i.e., overuse of variable number of positional arguments). This allows to make use of Must documentation (https://www.biomecardio.com/MUST/documentation.html). Keep in mind that, since Python does not allow a changing number of returns, each function will output the maximum number of variables of the matlab version.
77

88
## Installation
9+
You can obtain the latest version from github, or alternatively install it using pip or conda. Please note that the github version might have bugs or other issues, since it is in development. Do not hesitate to create an issue in Pymust.
10+
911
### Install from pip
1012
> pip install pymust
1113
14+
### Install from conda
15+
> conda install -c conda-forge pymut
16+
1217
### Download from github
18+
1319
To install a local version of pymust with its dependencies (matplotlib, scipy, numpy), download it, go to the main folder and then run:
20+
> pip install -e .
21+
>
1422
The package works in OsX, Linux and Windows (but parallelism might not be available on Windows). We recommend installing it in a separate conda environment.
1523

1624
To install pymust with its dependencies (matplotlib, scipy, numpy), you can directly install from pip:
1725
> pip install git+https://github.com/creatis-ULTIM/PyMUST.git
1826
19-
Alternatively, you can install from the test pypi using the following instruction:
20-
> python3 -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ PyMUST
21-
2227
## Main functions
2328
Please refer to the Matlab documentation or examples for a full description of the functions involved
2429
- Transducer definition (getparam)
@@ -27,13 +32,19 @@ Please refer to the Matlab documentation or examples for a full description of t
2732
- Bmode and Doppler image beamforming from radiofrequencies (tgc, rf2iq, das, bmode, iq2doppler)
2833

2934
## Examples
30-
In the folder "examples", you have python notebooks ilustrating the main functionalities of PyMUST. They are the same as the ones available in the Matlab version.
35+
In the folder "examples", you have python notebooks ilustrating the main functionalities of PyMUST. They are the same as the ones available in the Matlab version. As a quickstart, please use this [notebook](examples/quickstart_demo.ipynb). There are also more specific demos for some fetures:
36+
- [3D acoustics](examples/pfield3.ipynb)
37+
- [Motion estimation](examples/rotatingDiskVelocitySynthetic.ipynb)
38+
39+
## Tutorials
40+
The tutorials [folder](tutorials) are incomplete notebooks for a course at Universitat Pompeu Fabra on ultrasound image acquisition and reconstruction (Biomedical Imaging Systems), that students need to complete during the practical sessions.
3141

3242
## Next steps
3343
If there is a functionality that you would like to see, please open an issue.
3444
- Update function documentation.
3545
- Find computational bottlenecks, and optimise (possibly with C extensions).
36-
- GPU acceleration
46+
- GPU acceleration (coming soon!)
47+
- Harmonic imaging (coming soon!)
3748
- Differentiable rendering.
3849

3950
## Citation

0 commit comments

Comments
 (0)