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 1 commit
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
21 changes: 21 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,26 @@
# 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 https://github.com/MDAnalysis/distopia.git
Copy link
Copy Markdown
Contributor

@PardhavMaradani PardhavMaradani Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't it be easier to specify this here in the clone itself as:
git clone --recurse-submodules https://github.com/MDAnalysis/distopia.git

or if we need to specify it separately as:
git submodule update --init --recursive

Copy link
Copy Markdown
Member Author

@orbeckst orbeckst Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In principle, yes, that's easier.

Just note that we don't need the vendored highway as we can use the conda-forge package instead if we like and build with DISTOPIA_USE_EXTERNAL_HWY=On.

Copy link
Copy Markdown
Member Author

@orbeckst orbeckst Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated using your suggestion and explained the two special build flags.

cd distopia
```

We also need `highway`, which vendored as a git submodule:
```bash
git submodule update --init libdistopia/highway
```

For testing and benchmarking get `googlebench` and `googletest`:
```bash
git submodule update --init libdistopia/googlebench
git submodule update --init libdistopia/googletest
```


## Building

Distopia uses the scikit-build build system. You can build the library easily by first installing the prerequisites.
Expand Down
Loading