You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-5Lines changed: 16 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,19 +6,24 @@ This is a Python reimplementation of the MUST ultrasound toolbox for synthetic i
6
6
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.
7
7
8
8
## 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
+
9
11
### Install from pip
10
12
> pip install pymust
11
13
14
+
### Install from conda
15
+
> conda install -c conda-forge pymut
16
+
12
17
### Download from github
18
+
13
19
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
+
>
14
22
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.
15
23
16
24
To install pymust with its dependencies (matplotlib, scipy, numpy), you can directly install from pip:
Please refer to the Matlab documentation or examples for a full description of the functions involved
24
29
- Transducer definition (getparam)
@@ -27,13 +32,19 @@ Please refer to the Matlab documentation or examples for a full description of t
27
32
- Bmode and Doppler image beamforming from radiofrequencies (tgc, rf2iq, das, bmode, iq2doppler)
28
33
29
34
## 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:
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.
31
41
32
42
## Next steps
33
43
If there is a functionality that you would like to see, please open an issue.
34
44
- Update function documentation.
35
45
- Find computational bottlenecks, and optimise (possibly with C extensions).
0 commit comments