Skip to content

Commit 14899d2

Browse files
authored
Merge branch 'master' into 592-sim-checkpoints
2 parents fa6ac1f + 4435c27 commit 14899d2

4 files changed

Lines changed: 11 additions & 9 deletions

File tree

docs/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,12 @@ To install the most recent build of k-Wave-python from PyPI, run:
3434
```bash
3535
pip install k-wave-python
3636
```
37-
37+
> **Note for MacOS:**
38+
>
39+
> k-wave-python offers initial support for MacOS, but you will need to install the following dependencies using the [brew package manager](https://docs.brew.sh/Installation) along with the Python package:
40+
> ```bash
41+
> brew install fftw hdf5 zlib libomp
42+
> ```
3843
After installing the Python package, the required binaries will be downloaded and installed the first time you run a
3944
simulation.
4045

docs/development/development_environment.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,7 @@ Environment Setup with uv
99
-------------------------
1010

1111
1. Install uv
12-
~~~~~~~~~~~~~
13-
.. code-block:: bash
14-
15-
curl -LsSf https://astral.sh/uv/install.sh | sh
12+
Uv is "An extremely fast Python package and project manager, written in Rust." We would recommend that you use it. Installation instructions can be found `here <https://docs.astral.sh/uv/getting-started/installation/#installation-methods>`_.
1613

1714
2. Clone the Repository
1815
~~~~~~~~~~~~~~~~~~~~~~~
@@ -171,7 +168,7 @@ Publishing k-wave-python
171168
`Hatch <https://hatch.pypa.io/latest/>`_ is used to publish k-wave-python to `PyPI <https://pypi.org/>`_.
172169

173170
.. note::
174-
This is only performed by developers with write access to the k-wave-python package on PiPI.
171+
This is only performed by developers with write access to the k-wave-python package on PyPI.
175172

176173
The package can be built using:
177174

kwave/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def get_windows_release_urls(architecture: str) -> list:
5858
},
5959
"darwin": {
6060
"cuda": [],
61-
"omp": [URL_BASE + f"k-wave-omp-{PLATFORM}/releases/download/v0.3.0rc2/{EXECUTABLE_PREFIX}OMP"],
61+
"omp": [URL_BASE + f"k-wave-omp-{PLATFORM}/releases/download/v0.3.0rc3/{EXECUTABLE_PREFIX}OMP"],
6262
},
6363
"windows": {architecture: get_windows_release_urls(architecture) for architecture in ARCHITECTURES},
6464
}

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ dependencies = [
2929
"opencv-python==4.11.0.86",
3030
"deepdiff==8.4.2",
3131
"numpy>=1.22.2,<2.3.0",
32-
"matplotlib==3.10.1",
32+
"matplotlib==3.10.3",
3333
"beartype==0.20.2",
34-
"jaxtyping==0.3.1",
34+
"jaxtyping==0.3.2",
3535
"deprecated>=1.2.14"
3636
]
3737

0 commit comments

Comments
 (0)