CONTRIBUTING.rst

Contributing to Xeus-Octave

Xeus and Xeus-Octave are subprojects of Project Jupyter and subject to the Jupyter governance and Code of conduct.

General Guidelines

For general documentation about contributing to Jupyter projects, see the Project Jupyter Contributor Documentation.

Community

The Xeus team organizes public video meetings. The schedule for future meetings and minutes of past meetings can be found on our team compass.

Setting up a development environment

First, you need to fork the project. Then setup your environment:

# Create a new conda environment
mamba create -n xeus-octave -f environment-dev.yml
mamba activate -n xeus-octave

# Download xeus-octave from your GitHub fork
git clone https://github.com/<your-github-username>/xeus-octave.git

Development tools such as a C++ compiler, CMake, etc. are provided in the environment-dev.yml dependency file.

Building and installing Xeus-Octave

# Generate the project configuration files with Cmake in "build" directory
cmake -B build \
    -D CMAKE_BUILD_TYPE=Release  \
    -D CMAKE_PREFIX_PATH="${CONDA_PREFIX}" \
    -D CMAKE_INSTALL_PREFIX="${CONDA_PREFIX}"
# Build xeus-octave
cmake --build build --parallel 2
# Install xeus-octave
cmake --install build

Running the tests

The kernel tests are implemented through a Python test suite.

python -m pytest test/