|
7 | 7 | Currently, this work is a *very* early work in progress. Refer to |
8 | 8 | https://github.com/MicroscPSF/MicroscPSF-Matlab for the reference implementation. |
9 | 9 |
|
10 | | -## Quick start |
11 | | - |
12 | | -### Ubuntu/Linux |
| 10 | +## Quick start on Ubuntu/Linux |
13 | 11 |
|
14 | 12 | Install the compiler toolchain and the BLAS/LAPACK library: |
15 | 13 |
|
@@ -53,10 +51,37 @@ ninja all |
53 | 51 | sudo ninja install |
54 | 52 | ``` |
55 | 53 |
|
| 54 | +## Other operating system support |
| 55 | + |
| 56 | +### Windows |
| 57 | + |
| 58 | +The C++ library only offers experimental support on MSVC/MinGW toolchain. Please |
| 59 | +refer to the build instruction file for details: https://github.com/MicroscPSF/MicroscPSF-Cpp/blob/main/.github/workflows/validate-build.yml |
| 60 | + |
| 61 | +### MacOSX |
| 62 | + |
| 63 | +Mac provides a nice *Accelerate* LAPACK interface in the Apple Framework. The |
| 64 | +build system is capable of [automatically detecting the framework as build |
| 65 | +depdendency](https://mesonbuild.com/Dependencies.html#appleframeworks), so the |
| 66 | +library should be able to compile and run PSF simulation natively. |
| 67 | + |
| 68 | +The project is looking for volunteers and incoming PRs to enable Mac support. |
| 69 | + |
| 70 | +Wishlist: |
| 71 | + |
| 72 | +- [X] Enable Bessel function support from 3rd party library #14 . |
| 73 | + |
| 74 | +- [ ] Modify |
| 75 | + [meson.build](https://github.com/MicroscPSF/MicroscPSF-Cpp/blob/main/3rdparty/packagefiles/armadillo-code/meson.build#L19) |
| 76 | + to detect the Accelerate LAPACK interface in Apple Framework. |
| 77 | + |
| 78 | +- [ ] Document the build options, i.e. `meson setup -Duse_boost=true -Darmadillo-code:lapack=framework build-for-macosx` |
| 79 | + |
56 | 80 | ## Running the examples |
57 | 81 |
|
58 | 82 | First, follow the *Quick start* instructions to build the example app. Then, given the following microscope configurations in the screenshot... |
59 | | - |
| 83 | + |
| 84 | + |
60 | 85 |
|
61 | 86 | ... program the example C++ file at |
62 | 87 | [examples/generate-psf.cpp](https://github.com/MicroscPSF/MicroscPSF-Cpp/blob/main/examples/generate-psf.cpp) |
@@ -89,4 +114,4 @@ screenshot above. |
89 | 114 | - The original ISO C++ proposal: https://wg21.link/p0226r1 |
90 | 115 | - GCC compiler support status: https://gcc.gnu.org/onlinedocs/libstdc++/manual/status.html#status.iso.2017 |
91 | 116 | - Clang support status: https://libcxx.llvm.org/Status/Cxx17.html |
92 | | -- Clang support ticket: https://github.com/llvm/llvm-project/issues/99939 |
| 117 | +- Clang support ticket: https://github.com/llvm/llvm-project/issues/99939 |
0 commit comments