From 786affde538682e9627cdbb2d29ba965e2110855 Mon Sep 17 00:00:00 2001 From: mcbarton Date: Thu, 6 Mar 2025 15:07:50 +0000 Subject: [PATCH 1/9] Remove restriction on cpp-argparse version --- README.md | 9 +++++++-- docs/source/InstallationAndUsage.rst | 2 +- environment-dev.yml | 2 +- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a3b88384..e8984a27 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ source activate "xeus-cpp" ``` We will now install the dependencies needed to compile xeux-cpp from source within this environment by executing the following ```bash -mamba install notebook cmake cxx-compiler xeus-zmq nlohmann_json=3.11.3 jupyterlab CppInterOp cpp-argparse">=3.0,<4.0" pugixml doctest -c conda-forge +mamba install notebook cmake cxx-compiler xeus-zmq nlohmann_json=3.11.3 jupyterlab CppInterOp cpp-argparse pugixml doctest -c conda-forge ``` Now you can compile the kernel from the source by executing (replace `$CONDA_PREFIX` with a custom installation prefix if need be) ```bash @@ -136,9 +136,14 @@ http://xeus-cpp.readthedocs.io - [argparse](https://github.com/p-ranav/argparse) - [CppInterOp](https://github.com/compiler-research/CppInterOp) +| `xeus-cpp` | `xeus-zmq` | `CppInterOp` | `pugixml` | `nlohmann_json` | +|------------|-----------------|--------------|-----------|-----------------| +| main | >=3.0.0,<4.0.0 | >=1.5.0 | ~1.8.1 | >=3.11.3,<4.0 | + +Versions `0.6.0` and prior had a restriction on the exact version of cpp-argparse used + | `xeus-cpp` | `xeus-zmq` | `CppInterOp` | `pugixml` | `cpp-argparse`| `nlohmann_json` | |------------|-----------------|--------------|-----------|---------------|-----------------| -| main | >=3.0.0,<4.0.0 | >=1.5.0 | ~1.8.1 | >=3.0,<4.0 | >=3.11.3,<4.0 | | 0.6.0 | >=3.0.0,<4.0.0 | >=1.5.0 | ~1.8.1 | <3.1 | >=3.11.3,<4.0 | | 0.5.0 | >=3.0.0,<4.0.0 | >=1.3.0 | ~1.8.1 | <3.1 | >=3.11.3,<4.0 | diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index eb892b8b..ea2ea30e 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -30,7 +30,7 @@ this environment by executing the following .. code-block:: bash mamba install notebook cmake cxx-compiler xeus-zmq nlohmann_json=3.11.3 - jupyterlab CppInterOp cpp-argparse">=3.0,<4.0" pugixml doctest -c conda-forge + jupyterlab CppInterOp cpp-argparse pugixml doctest -c conda-forge Now you can compile the kernel from the source by executing (replace `$CONDA_PREFIX` with a custom installation prefix if need be) diff --git a/environment-dev.yml b/environment-dev.yml index e4adecac..48bebaac 100644 --- a/environment-dev.yml +++ b/environment-dev.yml @@ -12,7 +12,7 @@ dependencies: - nlohmann_json=3.11.3 - CppInterOp - pugixml - - cpp-argparse>=3.0,<4.0 + - cpp-argparse # Test dependencies - pytest - jupyter_kernel_test<0.8 From 0e42de76bcd4ccc20fde9d323368d63da5119a81 Mon Sep 17 00:00:00 2001 From: mcbarton Date: Wed, 9 Apr 2025 08:46:39 +0100 Subject: [PATCH 2/9] Remove dependencies table --- README.md | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/README.md b/README.md index e8984a27..ae8ab797 100644 --- a/README.md +++ b/README.md @@ -136,26 +136,6 @@ http://xeus-cpp.readthedocs.io - [argparse](https://github.com/p-ranav/argparse) - [CppInterOp](https://github.com/compiler-research/CppInterOp) -| `xeus-cpp` | `xeus-zmq` | `CppInterOp` | `pugixml` | `nlohmann_json` | -|------------|-----------------|--------------|-----------|-----------------| -| main | >=3.0.0,<4.0.0 | >=1.5.0 | ~1.8.1 | >=3.11.3,<4.0 | - -Versions `0.6.0` and prior had a restriction on the exact version of cpp-argparse used - -| `xeus-cpp` | `xeus-zmq` | `CppInterOp` | `pugixml` | `cpp-argparse`| `nlohmann_json` | -|------------|-----------------|--------------|-----------|---------------|-----------------| -| 0.6.0 | >=3.0.0,<4.0.0 | >=1.5.0 | ~1.8.1 | <3.1 | >=3.11.3,<4.0 | -| 0.5.0 | >=3.0.0,<4.0.0 | >=1.3.0 | ~1.8.1 | <3.1 | >=3.11.3,<4.0 | - -Versions prior to `0.5.0` have an additional dependency on [xtl](https://github.com/xtensor-stack/xtl), [clang](https://github.com/llvm/llvm-project/) & [cppzmq](https://github.com/zeromq/cppzmq) - -| `xeus-cpp` | `xeus-zmq` | `xtl` | `clang` | `pugixml` | `cppzmq` | `cpp-argparse`| `nlohmann_json` | -|------------|-----------------|-----------------|-----------|-----------|----------|---------------|-----------------| -| 0.4.0 | >=1.0.0,<2.0.0 | >=0.7.7,<0.8.0 | >=16,<17 | ~1.8.1 | ~4.3.0 | ~2.9 | >=3.6.1,<4.0 | -| 0.3.0 | >=1.0.0,<2.0.0 | >=0.7.7,<0.8.0 | >=16,<17 | ~1.8.1 | ~4.3.0 | ~2.9 | >=3.6.1,<4.0 | -| 0.2.0 | >=1.0.0,<2.0.0 | >=0.7.7,<0.8.0 | >=16,<17 | ~1.8.1 | ~4.3.0 | ~2.9 | >=3.6.1,<4.0 | -| 0.1.0 | >=1.0.0,<2.0.0 | >=0.7.0,<0.8.0 | >=16,<17 | ~1.8.1 | ~4.3.0 | ~2.9 | >=3.6.1,<4.0 | - ## Contributing See [CONTRIBUTING.md](./CONTRIBUTING.md) to know how to contribute and set up a From 9af3b8c42420addf8781f436a50c89ec99c38332 Mon Sep 17 00:00:00 2001 From: mcbarton Date: Fri, 30 May 2025 08:18:44 +0100 Subject: [PATCH 3/9] Update README.md to address readme comments --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b60ba94f..c8b31360 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,8 @@ source activate "xeus-cpp" ``` We will now install the dependencies needed to compile xeux-cpp from source within this environment by executing the following ```bash -mamba install notebook cmake cxx-compiler xeus-zmq nlohmann_json=3.11.3 jupyterlab CppInterOp cpp-argparse pugixml doctest -c conda-forge +micromamba create -f environment-dev.yml +micromamba install jupyterlab -c conda-forge ``` Now you can compile the kernel from the source by executing (replace `$CONDA_PREFIX` with a custom installation prefix if need be) ```bash @@ -185,6 +186,12 @@ http://xeus-cpp.readthedocs.io - [argparse](https://github.com/p-ranav/argparse) - [CppInterOp](https://github.com/compiler-research/CppInterOp) +| `xeus-cpp` | `xeus-zmq` | `CppInterOp` | `pugixml` | `cpp-argparse`| `nlohmann_json` | +|------------|-----------------|--------------|-----------|---------------|-----------------| +| main | 3.1.0 | 1.7.0 | 1.15 | 3.2 | 3.12.0 | + +## Contributing + See [CONTRIBUTING.md](./CONTRIBUTING.md) to know how to contribute and set up a development environment. From 2460372e8e05a6e3fa6f1963d01f411929568a2c Mon Sep 17 00:00:00 2001 From: mcbarton Date: Fri, 30 May 2025 08:20:19 +0100 Subject: [PATCH 4/9] Update InstallationAndUsage.rst to address PR comment --- docs/source/InstallationAndUsage.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index be8da90d..3a090331 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -29,8 +29,8 @@ this environment by executing the following .. code-block:: bash - mamba install notebook cmake cxx-compiler xeus-zmq nlohmann_json=3.11.3 - jupyterlab CppInterOp cpp-argparse pugixml doctest -c conda-forge + micromamba create -f environment-dev.yml + micromamba install jupyterlab -c conda-forge Now you can compile the kernel from the source by executing (replace `$CONDA_PREFIX` with a custom installation prefix if need be) From 4acfc11beefff2c5575827eec23e0e451faebfe7 Mon Sep 17 00:00:00 2001 From: mcbarton Date: Fri, 30 May 2025 08:31:02 +0100 Subject: [PATCH 5/9] Apply PR suggestion --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index c8b31360..e055e2f9 100644 --- a/README.md +++ b/README.md @@ -185,6 +185,7 @@ http://xeus-cpp.readthedocs.io - [nlohmann_json](https://github.com/nlohmann/json) - [argparse](https://github.com/p-ranav/argparse) - [CppInterOp](https://github.com/compiler-research/CppInterOp) +- [pugixml](https://github.com/zeux/pugixml) | `xeus-cpp` | `xeus-zmq` | `CppInterOp` | `pugixml` | `cpp-argparse`| `nlohmann_json` | |------------|-----------------|--------------|-----------|---------------|-----------------| From aa9669f3eb7c87d34cf21dc18289c11ad8d4887b Mon Sep 17 00:00:00 2001 From: mcbarton Date: Fri, 30 May 2025 08:42:56 +0100 Subject: [PATCH 6/9] Update README.md to address PR comment --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index e055e2f9..b91a64f1 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,6 @@ cd ./xeus-cpp The safest usage of xeus-cpp from source is to build and install it within a clean environment named `xeus-cpp`. You can create and activate this environment with mamba by executing the following ```bash -mamba create -n "xeus-cpp" -source activate "xeus-cpp" -``` -We will now install the dependencies needed to compile xeux-cpp from source within this environment by executing the following -```bash micromamba create -f environment-dev.yml micromamba install jupyterlab -c conda-forge ``` From 0f1d8eb27bfd19a8a743e1c28fefad2f24aac938 Mon Sep 17 00:00:00 2001 From: mcbarton Date: Fri, 30 May 2025 08:43:37 +0100 Subject: [PATCH 7/9] Update InstallationAndUsage.rst to address PR comment --- docs/source/InstallationAndUsage.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index 3a090331..24c12051 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -19,14 +19,6 @@ The safest usage of xeus-cpp from source is to build and install it within a clean environment named `xeus-cpp`. You can create and activate this environment with mamba by executing the following -.. code-block:: bash - - mamba create -n "xeus-cpp" - source activate "xeus-cpp" - -We will now install the dependencies needed to compile xeux-cpp from source within -this environment by executing the following - .. code-block:: bash micromamba create -f environment-dev.yml From 53e34a73f259415d674c0a20c5d3819b4404a87f Mon Sep 17 00:00:00 2001 From: mcbarton Date: Fri, 30 May 2025 09:08:41 +0100 Subject: [PATCH 8/9] Address PR comment --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b91a64f1..8b7a84f8 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ The safest usage of xeus-cpp from source is to build and install it within a cle with mamba by executing the following ```bash micromamba create -f environment-dev.yml +micromamba activate xeus-cpp micromamba install jupyterlab -c conda-forge ``` Now you can compile the kernel from the source by executing (replace `$CONDA_PREFIX` with a custom installation prefix if need be) From 26ffb9bad69b682bdda7f16234d9aeaf63f11e00 Mon Sep 17 00:00:00 2001 From: mcbarton Date: Fri, 30 May 2025 09:09:26 +0100 Subject: [PATCH 9/9] Address PR comment --- docs/source/InstallationAndUsage.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index 24c12051..9656efae 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -22,6 +22,7 @@ this environment with mamba by executing the following .. code-block:: bash micromamba create -f environment-dev.yml + micromamba activate xeus-cpp micromamba install jupyterlab -c conda-forge Now you can compile the kernel from the source by executing (replace `$CONDA_PREFIX`