@@ -17,36 +17,42 @@ minutes of past meetings can be found on our
17
17
18
18
## Setting up a development environment
19
19
20
- First, you need to fork the project. Then setup your environment:
20
+ First, you need to fork the project. After you have done this clone your forked repo. You can do this by
21
+ executing the folowing
21
22
22
23
``` bash
23
- # create a new conda environment
24
- conda env create -f environment-dev.yml
25
- conda activate xeus-cpp
26
-
27
- # download xeus-cpp from your GitHub fork
28
24
git clone https://github.com/< your-github-username> /xeus-cpp.git
29
25
```
30
26
31
- You may also want to install a C++ compiler, and cmake from conda if they are not
32
- available on your system.
27
+ To ensure that the installation works, it is preferable to install xeus-cpp in a fresh environment. It is
28
+ also needed to use a miniforge or miniconda installation because with the full anaconda you may have a
29
+ conflict with the zeromq library which is already installed in the anaconda distribution. Once you have miniforge
30
+ or miniconda installed cd into the xeus-cpp directory and set setup your environment:
31
+
32
+ ``` bash
33
+ cd xeus-cpp
34
+ micromamba create -n xeus-cpp environment-dev.yml
35
+ micromamba activate xeus-cpp
36
+ ```
33
37
34
- ## Building and installing xeus-cpp
38
+ You are now in a position to install xeus-cpp into this envirnoment. You can do this by executing
35
39
36
40
``` bash
37
- # Create a directory for building
38
41
mkdir build && cd build
39
- # Generate the makefile with cmake
40
42
cmake -D CMAKE_BUILD_TYPE=Release -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib ..
41
- # Build and install
42
- make install -j2
43
+ make install
43
44
```
44
45
45
- ## Running the tests
46
+ To check that everything is installed correctly you can run the c++ tests by executing the following
47
+
48
+ ``` bash
49
+ cd ./test
50
+ ./test_xeus_cpp
51
+ ```
46
52
47
- To run Python tests, from the build directory, type
53
+ and the python tests by executing
48
54
49
55
``` bash
50
- cd .. /test
51
- pytest . -vvv
56
+ cd ./test
57
+ pytest -sv .
52
58
```
0 commit comments