From 7fd34b94894482aaea8047bb8928820d2ef0c8f5 Mon Sep 17 00:00:00 2001 From: mcbarton Date: Mon, 20 Jan 2025 20:07:42 +0000 Subject: [PATCH 1/7] Fix instructions for using emsdk --- CONTRIBUTING.md | 8 +++----- README.md | 8 +++----- docs/source/InstallationAndUsage.rst | 8 +++----- 3 files changed, 9 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed2efefc..df730e76 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,11 +70,9 @@ 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 ```bash -cd $HOME -git clone https://github.com/emscripten-core/emsdk.git -cd emsdk -./emsdk install 3.1.45 -./emsdk activate 3.1.45 +git clone https://github.com/emscripten-core/emsdk.git $HOME/emsdk +$HOME/emsdk install 3.1.45 +$HOME/emsdk activate 3.1.45 source $HOME/emsdk/emsdk_env.sh ``` diff --git a/README.md b/README.md index c987a379..77f3f54b 100644 --- a/README.md +++ b/README.md @@ -71,11 +71,9 @@ 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 ```bash -cd $HOME -git clone https://github.com/emscripten-core/emsdk.git -cd emsdk -./emsdk install 3.1.45 -./emsdk activate 3.1.45 +git clone https://github.com/emscripten-core/emsdk.git $HOME/emsdk +$HOME/emsdk install 3.1.45 +$HOME/emsdk activate 3.1.45 source $HOME/emsdk/emsdk_env.sh ``` diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index 9812813c..869fc0da 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -57,11 +57,9 @@ You'll now want to make sure you're using emsdk version "3.1.45" and activate it .. code-block:: bash - cd $HOME - git clone https://github.com/emscripten-core/emsdk.git - cd emsdk - ./emsdk install 3.1.45 - ./emsdk activate 3.1.45 + git clone https://github.com/emscripten-core/emsdk.git $HOME/emsdk + $HOME/emsdk install 3.1.45 + $HOME/emsdk activate 3.1.45 source $HOME/emsdk/emsdk_env.sh From 33fc5af3529ffab03f396caa80fa21d348c3dbc4 Mon Sep 17 00:00:00 2001 From: mcbarton Date: Mon, 20 Jan 2025 20:10:21 +0000 Subject: [PATCH 2/7] Fix micromamba activate command wasm build instructions --- CONTRIBUTING.md | 2 +- README.md | 2 +- docs/source/InstallationAndUsage.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df730e76..b496ee2e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,7 +97,7 @@ emmake make install To build Jupyter Lite with this kernel without creating a website you can execute the following ```bash micromamba create -n xeus-lite-host jupyterlite-core -micromamba activate xeus-lite-host +micromamba activate xeus-lite-host -c conda-forge python -m pip install jupyterlite-xeus jupyter lite build --XeusAddon.prefix=$PREFIX ``` diff --git a/README.md b/README.md index 77f3f54b..616884ec 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ emmake make install To build Jupyter Lite with this kernel without creating a website you can execute the following ```bash micromamba create -n xeus-lite-host jupyterlite-core -micromamba activate xeus-lite-host +micromamba activate xeus-lite-host -c conda-forge python -m pip install jupyterlite-xeus jupyter lite build --XeusAddon.prefix=$PREFIX ``` diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index 869fc0da..df259fda 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -87,7 +87,7 @@ To build Jupyter Lite with this kernel without creating a website you can execut .. code-block:: bash micromamba create -n xeus-lite-host jupyterlite-core - micromamba activate xeus-lite-host + micromamba activate xeus-lite-host -c conda-forge python -m pip install jupyterlite-xeus jupyter lite build --XeusAddon.prefix=$PREFIX From 88d44c76a96469dedfdfaa48b795fa13d1263bcd Mon Sep 17 00:00:00 2001 From: mcbarton Date: Mon, 20 Jan 2025 20:13:02 +0000 Subject: [PATCH 3/7] Put -c conda-forge in correct place --- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- docs/source/InstallationAndUsage.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b496ee2e..c4d49137 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,8 +96,8 @@ emmake make install To build Jupyter Lite with this kernel without creating a website you can execute the following ```bash -micromamba create -n xeus-lite-host jupyterlite-core -micromamba activate xeus-lite-host -c conda-forge +micromamba create -n xeus-lite-host jupyterlite-core -c conda-forge +micromamba activate xeus-lite-host python -m pip install jupyterlite-xeus jupyter lite build --XeusAddon.prefix=$PREFIX ``` diff --git a/README.md b/README.md index 616884ec..31f76396 100644 --- a/README.md +++ b/README.md @@ -97,8 +97,8 @@ emmake make install To build Jupyter Lite with this kernel without creating a website you can execute the following ```bash -micromamba create -n xeus-lite-host jupyterlite-core -micromamba activate xeus-lite-host -c conda-forge +micromamba create -n xeus-lite-host jupyterlite-core -c conda-forge +micromamba activate xeus-lite-host python -m pip install jupyterlite-xeus jupyter lite build --XeusAddon.prefix=$PREFIX ``` diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index df259fda..64c06621 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -86,8 +86,8 @@ To build Jupyter Lite with this kernel without creating a website you can execut .. code-block:: bash - micromamba create -n xeus-lite-host jupyterlite-core - micromamba activate xeus-lite-host -c conda-forge + micromamba create -n xeus-lite-host jupyterlite-core -c conda-forge + micromamba activate xeus-lite-host python -m pip install jupyterlite-xeus jupyter lite build --XeusAddon.prefix=$PREFIX From 466fbeb9b89a3e1ecc6e1a5d279a141edcb3544a Mon Sep 17 00:00:00 2001 From: mcbarton Date: Mon, 20 Jan 2025 21:27:37 +0000 Subject: [PATCH 4/7] Fix emsk install and activate commands --- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- docs/source/InstallationAndUsage.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c4d49137..587c177a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,8 +71,8 @@ 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 ```bash git clone https://github.com/emscripten-core/emsdk.git $HOME/emsdk -$HOME/emsdk install 3.1.45 -$HOME/emsdk activate 3.1.45 +$HOME/emsdk/emsdk install 3.1.45 +$HOME/emsdk/emsdk activate 3.1.45 source $HOME/emsdk/emsdk_env.sh ``` diff --git a/README.md b/README.md index 31f76396..690bc37e 100644 --- a/README.md +++ b/README.md @@ -72,8 +72,8 @@ 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 ```bash git clone https://github.com/emscripten-core/emsdk.git $HOME/emsdk -$HOME/emsdk install 3.1.45 -$HOME/emsdk activate 3.1.45 +$HOME/emsdk/emsdk install 3.1.45 +$HOME/emsdk/emsdk activate 3.1.45 source $HOME/emsdk/emsdk_env.sh ``` diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index 64c06621..3109c87f 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -58,8 +58,8 @@ You'll now want to make sure you're using emsdk version "3.1.45" and activate it .. code-block:: bash git clone https://github.com/emscripten-core/emsdk.git $HOME/emsdk - $HOME/emsdk install 3.1.45 - $HOME/emsdk activate 3.1.45 + $HOME/emsdk/emsdk install 3.1.45 + $HOME/emsdk/emsdk activate 3.1.45 source $HOME/emsdk/emsdk_env.sh From 873415212b28b6ba2ff08992e2b4d2c69b429272 Mon Sep 17 00:00:00 2001 From: mcbarton Date: Wed, 22 Jan 2025 08:31:03 +0000 Subject: [PATCH 5/7] Using emsdk from environment-wasm-build.yml file --- CONTRIBUTING.md | 9 ++++----- README.md | 9 ++++----- docs/source/InstallationAndUsage.rst | 9 ++++----- 3 files changed, 12 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 587c177a..06cfc07d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,12 +68,11 @@ git clone https://github.com//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 +You'll now want to make sure you are using the same emsdk as the rest of our dependencies. This can be achieved by executing +the following ```bash -git clone https://github.com/emscripten-core/emsdk.git $HOME/emsdk -$HOME/emsdk/emsdk install 3.1.45 -$HOME/emsdk/emsdk activate 3.1.45 -source $HOME/emsdk/emsdk_env.sh +micromamba create -f environment-wasm-build.yml -y +micromamba activate xeus-cpp-wasm-build ``` You are now in a position to build the xeus-cpp kernel. You build it by executing the following diff --git a/README.md b/README.md index 690bc37e..a88da8b3 100644 --- a/README.md +++ b/README.md @@ -69,12 +69,11 @@ 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 +You'll now want to make sure you are using the same emsdk as the rest of our dependencies. This can be achieved by executing +the following ```bash -git clone https://github.com/emscripten-core/emsdk.git $HOME/emsdk -$HOME/emsdk/emsdk install 3.1.45 -$HOME/emsdk/emsdk activate 3.1.45 -source $HOME/emsdk/emsdk_env.sh +micromamba create -f environment-wasm-build.yml -y +micromamba activate xeus-cpp-wasm-build ``` You are now in a position to build the xeus-cpp kernel. You build it by executing the following diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index 3109c87f..2d9a0022 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -53,15 +53,14 @@ These instructions will assume you have cmake installed on your system. First cl 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 +You'll now want to make sure you are using the same emsdk as the rest of our dependencies. This can be achieved by executing +the following .. code-block:: bash - git clone https://github.com/emscripten-core/emsdk.git $HOME/emsdk - $HOME/emsdk/emsdk install 3.1.45 - $HOME/emsdk/emsdk activate 3.1.45 - source $HOME/emsdk/emsdk_env.sh + micromamba create -f environment-wasm-build.yml -y + micromamba activate xeus-cpp-wasm-build You are now in a position to build the xeus-cpp kernel. You build it by executing the following From 9e27b4c29ce9868e91a46f693e8e047ce611c018 Mon Sep 17 00:00:00 2001 From: mcbarton Date: Wed, 22 Jan 2025 09:47:35 +0000 Subject: [PATCH 6/7] Update PR based on comment --- CONTRIBUTING.md | 6 +++--- README.md | 6 +++--- docs/source/InstallationAndUsage.rst | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06cfc07d..847b199b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,9 +79,9 @@ You are now in a position to build the xeus-cpp kernel. You build it by executin ```bash micromamba create -f environment-wasm-host.yml --platform=emscripten-wasm32 mkdir build -pushd build -export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-host -export SYSROOT_PATH=$HOME/emsdk/upstream/emscripten/cache/sysroot +cd build +export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-build +export SYSROOT_PATH=$PREFIX/opt/emsdk/upstream/emscripten/cache/sysroot emcmake cmake \ -DCMAKE_BUILD_TYPE=Release \ diff --git a/README.md b/README.md index a88da8b3..a6100920 100644 --- a/README.md +++ b/README.md @@ -80,9 +80,9 @@ You are now in a position to build the xeus-cpp kernel. You build it by executin ```bash micromamba create -f environment-wasm-host.yml --platform=emscripten-wasm32 mkdir build -pushd build -export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-host -export SYSROOT_PATH=$HOME/emsdk/upstream/emscripten/cache/sysroot +cd build +export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-build +export SYSROOT_PATH=$PREFIX/opt/emsdk/upstream/emscripten/cache/sysroot emcmake cmake \ -DCMAKE_BUILD_TYPE=Release \ diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index 2d9a0022..df1017e2 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -68,9 +68,9 @@ You are now in a position to build the xeus-cpp kernel. You build it by executin micromamba create -f environment-wasm-host.yml --platform=emscripten-wasm32 mkdir build - pushd build - export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-host - export SYSROOT_PATH=$HOME/emsdk/upstream/emscripten/cache/sysroot + cd build + export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-build + export SYSROOT_PATH=$PREFIX/opt/emsdk/upstream/emscripten/cache/sysroot emcmake cmake \ -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_INSTALL_PREFIX=$PREFIX \ From 8ea4937d38497d2b06e4b8bc32e2c8c20eb0a90d Mon Sep 17 00:00:00 2001 From: mcbarton Date: Wed, 22 Jan 2025 10:13:09 +0000 Subject: [PATCH 7/7] Fix instructions --- CONTRIBUTING.md | 5 +++-- README.md | 5 +++-- docs/source/InstallationAndUsage.rst | 5 +++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 847b199b..9a9e4c39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,8 +80,9 @@ You are now in a position to build the xeus-cpp kernel. You build it by executin micromamba create -f environment-wasm-host.yml --platform=emscripten-wasm32 mkdir build cd build -export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-build -export SYSROOT_PATH=$PREFIX/opt/emsdk/upstream/emscripten/cache/sysroot +export BUILD_TOOLS_PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-build +export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-host +export SYSROOT_PATH=$BUILD_TOOLS_PREFIX/opt/emsdk/upstream/emscripten/cache/sysroot emcmake cmake \ -DCMAKE_BUILD_TYPE=Release \ diff --git a/README.md b/README.md index a6100920..30545bec 100644 --- a/README.md +++ b/README.md @@ -81,8 +81,9 @@ You are now in a position to build the xeus-cpp kernel. You build it by executin micromamba create -f environment-wasm-host.yml --platform=emscripten-wasm32 mkdir build cd build -export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-build -export SYSROOT_PATH=$PREFIX/opt/emsdk/upstream/emscripten/cache/sysroot +export BUILD_TOOLS_PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-build +export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-host +export SYSROOT_PATH=$BUILD_TOOLS_PREFIX/opt/emsdk/upstream/emscripten/cache/sysroot emcmake cmake \ -DCMAKE_BUILD_TYPE=Release \ diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index df1017e2..0ece4b01 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -69,8 +69,9 @@ You are now in a position to build the xeus-cpp kernel. You build it by executin micromamba create -f environment-wasm-host.yml --platform=emscripten-wasm32 mkdir build cd build - export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-build - export SYSROOT_PATH=$PREFIX/opt/emsdk/upstream/emscripten/cache/sysroot + export BUILD_TOOLS_PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-build + export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-host + export SYSROOT_PATH=$BUILD_TOOLS_PREFIX/opt/emsdk/upstream/emscripten/cache/sysroot emcmake cmake \ -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_INSTALL_PREFIX=$PREFIX \