Skip to content

Fix online wasm build instructions #226

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

Merged
merged 1 commit into from
Jan 20, 2025
Merged

Fix online wasm build instructions #226

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
14 changes: 6 additions & 8 deletions docs/source/InstallationAndUsage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,17 @@ Installation within a mamba environment (wasm build instructions)
========================

These instructions will assume you have cmake installed on your system. First clone the repository, and move into that directory

.. code-block:: bash

git clone --depth=1 https://github.com/compiler-research/xeus-cpp.git
cd ./xeus-cpp


You'll now want to make sure you're using emsdk version "3.1.45" and activate it. You can get this by executing the following

.. code-block:: bash

cd $HOME
git clone https://github.com/emscripten-core/emsdk.git
cd emsdk
Expand All @@ -65,6 +68,7 @@ You'll now want to make sure you're using emsdk version "3.1.45" and activate it
You are now in a position to build the xeus-cpp kernel. You build it by executing the following

.. code-block:: bash

micromamba create -f environment-wasm-host.yml --platform=emscripten-wasm32
mkdir build
pushd build
Expand All @@ -83,22 +87,16 @@ You are now in a position to build the xeus-cpp kernel. You build it by executin
To build Jupyter Lite with this kernel without creating a website you can execute the following

.. code-block:: bash

micromamba create -n xeus-lite-host jupyterlite-core
micromamba activate xeus-lite-host
python -m pip install jupyterlite-xeus
jupyter lite build --XeusAddon.prefix=$PREFIX

We now need to shift necessary files like `xcpp.data` which contains the binary representation of the file(s)
we want to include in our application. As of now this would contain all important files like Standard Headers,
Libraries etc coming out of emscripten's sysroot. Assuming we are still inside build we should do the following

.. code-block:: bash
cp $PREFIX/bin/xcpp.data _output/extensions/@jupyterlite/xeus/static
cp $PREFIX/lib/libclangCppInterOp.so _output/extensions/@jupyterlite/xeus/static

Copy link
Collaborator

Choose a reason for hiding this comment

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

Damn not sure how I missed this in my PR. Weird !

Thanks for fixing this !

Once the Jupyter Lite site has built you can test the website locally by executing

.. code-block:: bash

jupyter lite serve --XeusAddon.prefix=$PREFIX

Installing from conda-forge
Expand Down