@@ -5,20 +5,13 @@ You can build `distopia` from source.
55## Checking out the sources
66Get the latest sources from the repository https://github.com/MDAnalysis/distopia
77``` bash
8- git clone https://github.com/MDAnalysis/distopia.git
8+ git clone --recurse-submodules https://github.com/MDAnalysis/distopia.git
99cd distopia
1010```
1111
12- We also need ` highway ` , which vendored as a git submodule:
13- ``` bash
14- git submodule update --init libdistopia/highway
15- ```
16-
17- For testing and benchmarking get ` googlebench ` and ` googletest ` :
18- ``` bash
19- git submodule update --init libdistopia/googlebench
20- git submodule update --init libdistopia/googletest
21- ```
12+ Note that we are using git submodules for the vendored [ highway] ( https://github.com/google/highway )
13+ library (in ` libdistopia/highway ` , release 1.3.0) and for Google tests and Google benchmarks (in
14+ ` libdistopia/googletest ` and ` libdistopia/googlebench ` ).
2215
2316
2417## Building
@@ -37,6 +30,14 @@ If you want greater control over build and install options you can do a more man
3730python setup.py install -- -DCMAKE_BUILD_TYPE=Release < etc etc>
3831```
3932
33+ Special CMake flags
34+ - ` DISTOPIA_USE_EXTERNAL_HWY ` :
35+ - Off (default) — build with the vendored highway library
36+ - On — link to an installed libhwy (install with ` mamba install libhwy ` )
37+ - ` DISTOPIA_BUILD_TESTS ` :
38+ - On (default) — build the tests for libdistopia and the benchmarks
39+ - Off — do not build tests and benchmarks
40+
4041## Testing
4142
4243Testing for distopia is done on two levels. The ` distopia ` python layer has ` pytest ` tests you can run after installing the package.
0 commit comments