Skip to content

[docs] get sources and submodules #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
orbeckst wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[docs] get sources and submodules #191

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50673c0
[docs] get sources and submodules
orbeckst Apr 3, 2026
2cca2ae
Update building_and_testing.md
orbeckst Apr 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/docs/building_and_testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Building and testing

You can build `distopia` from source.

## Checking out the sources
Get the latest sources from the repository https://github.com/MDAnalysis/distopia
```bash
git clone --recurse-submodules https://github.com/MDAnalysis/distopia.git
cd distopia
```

Note that we are using git submodules for the vendored [highway](https://github.com/google/highway)
library (in `libdistopia/highway`, release 1.3.0) and for Google tests and Google benchmarks (in
`libdistopia/googletest` and `libdistopia/googlebench`).


## Building

Distopia uses the scikit-build build system. You can build the library easily by first installing the prerequisites.
Expand All @@ -16,6 +30,14 @@ If you want greater control over build and install options you can do a more man
python setup.py install -- -DCMAKE_BUILD_TYPE=Release <etc etc>
```

Special CMake flags
- `DISTOPIA_USE_EXTERNAL_HWY`:
- Off (default) — build with the vendored highway library
- On — link to an installed libhwy (install with `mamba install libhwy`)
- `DISTOPIA_BUILD_TESTS`:
- On (default) — build the tests for libdistopia and the benchmarks
- Off — do not build tests and benchmarks

## Testing

Testing for distopia is done on two levels. The `distopia` python layer has `pytest` tests you can run after installing the package.
Expand Down
Loading