Skip to content

Commit d29c271

Browse files
charlesbmialexrockhill
authored andcommitted
[Maint] update docs (Forest-Neurotech#21)
* Remove duplicate doc message * Fix relative links that are used in 2 places * Don't need to run test on RST changes --------- Co-authored-by: Charles Guan <3221512+charlesincharge@users.noreply.github.com>
1 parent 2664afb commit d29c271

File tree

5 files changed

+12
-8
lines changed

5 files changed

+12
-8
lines changed

.github/workflows/test_cpu.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ on:
88
paths:
99
- "**"
1010
- "!**.md"
11+
- "!**.rst"
12+
- "!docs/**"
1113
- "!.bumpversion.toml"
1214
- "!.gitignore"
1315
- "!**.cu"

.github/workflows/test_gpu.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ on:
1111
paths:
1212
- "**"
1313
- "!**.md"
14+
- "!**.rst"
15+
- "!docs/**"
1416
- "!.bumpversion.toml"
1517
- "!.gitignore"
1618
- "!.github/workflows/*.yml"

.github/workflows/wheels.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ on:
66
paths:
77
- "**"
88
- "!**.md"
9+
- "!**.rst"
10+
- "!docs/**"
911
- "!test_*.py"
1012
- "!tests/**"
1113
- "!.github/workflows/*.yml"

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ An ultrafast CUDA-accelerated ultrasound beamformer for Python users. Developed
99

1010
![Benchmark Results](assets/benchmark-doppler_disk.svg)
1111

12-
_Beamforming PyMUST's [rotating-disk Doppler dataset](https://github.com/creatis-ULTIM/PyMUST/blob/170ba68/examples/rotatingDisk_real.ipynb) at 0.86 trillion points per second (**5**x the speed of sound)_
12+
_Beamforming PyMUST's [rotating-disk Doppler dataset](https://github.com/creatis-ULTIM/PyMUST/blob/170ba68/examples/rotatingDisk_real.ipynb) at 0.86 trillion points per second (**5**x the speed of sound)._
1313

1414
> **⚠️ Alpha Release**
1515
>
@@ -21,13 +21,13 @@ _Beamforming PyMUST's [rotating-disk Doppler dataset](https://github.com/creatis
2121
***Ultra-fast beamforming**: ~10x faster than prior state-of-the-art
2222
* 🚀 **GPU-accelerated**: Leverages CUDA for maximum performance on NVIDIA GPUs
2323
* 🎯 **Optimized for research**: Designed for functional ultrasound imaging (fUSI) and other ultrafast, high-channel-count, or volumetric-ensemble imaging
24-
* 🐍 **Python bindings**: Zero-copy integration with CuPy, and JAX arrays via [nanobind](https://nanobind.readthedocs.io/en/latest/index.html). NumPy support included.`
25-
* 🔬 **Validated**: Matches [vbeam](https://github.com/magnusdk/vbeam) and [PyMUST](https://github.com/creatis-ULTIM/PyMUST) [outputs](tests/compare)
24+
* 🐍 **Python bindings**: Zero-copy integration with CuPy, and JAX arrays via [nanobind](https://nanobind.readthedocs.io/en/latest/index.html). NumPy support included.
25+
* 🔬 **Validated**: Matches [vbeam](https://github.com/magnusdk/vbeam) and [PyMUST](https://github.com/creatis-ULTIM/PyMUST) [outputs](https://github.com/Forest-Neurotech/mach/tree/812062f/tests/compare)
2626

2727

2828
## Installation
2929

30-
Install from PyPI:
30+
### Install from PyPI (recommended):
3131

3232
```bash
3333
pip install mach-beamform
@@ -37,7 +37,7 @@ Wheel prerequisites:
3737
* [Linux](https://github.com/pypa/manylinux)
3838
* CUDA-enabled GPU with driver >= 12.3, [compute-capability >= 7.5](https://developer.nvidia.com/cuda-gpus)
3939

40-
Or, to build from source:
40+
### Build from source
4141

4242
```bash
4343
make compile
@@ -60,7 +60,7 @@ If you don't have a CUDA-enabled GPU, you can download the notebook from the [do
6060

6161
## Contributing
6262

63-
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
63+
We welcome contributions! Please see [CONTRIBUTING.md](https://github.com/Forest-Neurotech/mach/blob/812062f/CONTRIBUTING.md) for guidelines.
6464

6565
## Roadmap
6666

docs/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ mach
55

66
🚧 This documentation is under construction.
77

8-
**mach** is an ultrafast CUDA-accelerated ultrasound beamformer for Python users, developed at Forest Neurotech.
9-
108
.. include:: ../README.md
119
:parser: myst_parser.sphinx_
1210

0 commit comments

Comments
 (0)