Skip to content

Fix build instructions #408

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −23
Open

Fix build instructions #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 7 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,17 @@ mkdir build
cd build
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib
make check-xeus-cpp
make install
```

and

```bash
cd ../../test
cd ../test
pytest -sv test_xcpp_kernel.py
```

to perform the python tests. After you have checked that the kernel passes all the tests, you can install it by executing

```bash
make install
```
to perform the python tests.

## Setting up a development environment (wasm instructions)

Expand Down Expand Up @@ -99,9 +96,10 @@ emmake make check-xeus-cpp
emmake make install
```

It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following
It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following from the build folder

```bash
cd test
wget "https://download.mozilla.org/?product=firefox-latest&os=osx&lang=en-US" -O Firefox-latest.dmg
hdiutil attach Firefox-latest.dmg
cp -r /Volumes/Firefox/Firefox.app $PWD
Expand Down Expand Up @@ -132,9 +130,10 @@ python $BUILD_PREFIX/bin/emrun.py --no_browser --kill_exit --timeout 60 --browse
python ../../scripts/browser_tests_safari.py test_xeus_cpp.html
```

To do this on Ubuntu x86 execute the following
To run the browser tests on Ubuntu x86 execute the following from the build folder

```bash
cd test
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
dpkg-deb -x google-chrome-stable_current_amd64.deb $PWD/chrome
cd ./chrome/opt/google/chrome/
Expand Down
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,16 +63,14 @@ mkdir build
cd build
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib
make check-xeus-cpp
make install
```
and
```bash
cd ../../test
cd ../test
pytest -sv test_xcpp_kernel.py
```
to perform the python tests. After you have checked that the kernel passes all the tests, you can install it by executing

```bash
make install
to perform the python tests.
```

## Installation within a mamba environment (wasm build instructions)
Expand Down Expand Up @@ -114,9 +112,10 @@ emmake make check-xeus-cpp
emmake make install
```

It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following
It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following from the build folder

```bash
cd test
wget "https://download.mozilla.org/?product=firefox-latest&os=osx&lang=en-US" -O Firefox-latest.dmg
hdiutil attach Firefox-latest.dmg
cp -r /Volumes/Firefox/Firefox.app $PWD
Expand Down Expand Up @@ -147,9 +146,10 @@ python $BUILD_PREFIX/bin/emrun.py --no_browser --kill_exit --timeout 60 --browse
python ../../scripts/browser_tests_safari.py test_xeus_cpp.html
```

To do this on Ubuntu x86 execute the following
To run the browser tests on Ubuntu x86 execute the following from the build folder

```bash
cd test
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
dpkg-deb -x google-chrome-stable_current_amd64.deb $PWD/chrome
cd ./chrome/opt/google/chrome/
Expand Down
16 changes: 8 additions & 8 deletions docs/source/InstallationAndUsage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,17 @@ executing (replace `$CONDA_PREFIX` with a custom installation prefix if need be)
cd build
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib
make check-xeus-cpp
make install
Copy link
Collaborator Author

@mcbarton mcbarton Nov 10, 2025

Choose a reason for hiding this comment

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

I am not moving make install here because I think that is where it should be. Without it the kernel tests all error for me, since it assumes the kernels have been installed.


and

.. code-block:: bash

cd ../../test
Copy link
Collaborator Author

@mcbarton mcbarton Nov 10, 2025

Choose a reason for hiding this comment

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

This change is needed because we no longer cd into the test folder insider the build folder to run the C++ tests. We stay inside the build folder and run check-xeus-cpp. That means the source test folder is now only one folder up instead of 2.

cd ../test
pytest -sv test_xcpp_kernel.py

to perform the python tests. After you have checked that the kernel passes all the tests, you can install it by executing

.. code-block:: bash

make install
to perform the python tests.


Installation within a mamba environment (wasm build instructions)
========================
Expand Down Expand Up @@ -93,10 +91,11 @@ You are now in a position to build the xeus-cpp kernel. You build and test it in
emmake make check-xeus-cpp
emmake make install

It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following
It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following from the build folder

.. code-block:: bash

cd test
wget "https://download.mozilla.org/?product=firefox-latest&os=osx&lang=en-US" -O Firefox-latest.dmg
hdiutil attach Firefox-latest.dmg
cp -r /Volumes/Firefox/Firefox.app $PWD
Expand Down Expand Up @@ -126,10 +125,11 @@ python package. This only needs to be enable once, and then you can execute the
python $BUILD_PREFIX/bin/emrun.py --no_browser --kill_exit --timeout 60 --browser-args="--headless --no-sandbox" test_xeus_cpp.html &
python ../../scripts/browser_tests_safari.py test_xeus_cpp.html

To do this on Ubuntu x86 execute the following
To run the browser tests on Ubuntu x86 execute the following from the build folder

.. code-block:: bash

cd test
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
dpkg-deb -x google-chrome-stable_current_amd64.deb $PWD/chrome
cd ./chrome/opt/google/chrome/
Expand Down