OpenCLSim Notebooks

This is the repository with examples for the OpenCLSim package.

The first step is to get the OpenCLSim package. You can download and install the latest version of the OpenCLSim package using the following steps.

git clone https://github.com/TUDelft-CITG/OpenCLSim

Go to the correct folder

cd OpenCLSim

Install package

pip install -r requirements.txt
pip install -e .

The package documentation can be found here.

Example notebooks

The benefit of OpenCLSim is the generic set-up. This set-up allows the creation of complex logistical flows. A number of examples are presented in the notebooks folder. You can run them locally or as an Azure notebook.

Check the information on how to get started either way.

Using the notebooks locally

If you wish to use the notebooks on your local drive, use the following code to get started.

# Download the package
git clone https://github.com/TUDelft-CITG/OpenCLSim-Notebooks

# Go to the correct folder
cd OpenCLSim-Notebooks

# Install package
pip install -r requirements.txt

# Go to the notebooks foldeer
cd notebooks

# Start jupyter notebooks
jupyter notebook