Contributing

Welcome to quantflow repository! We are excited you are here and want to contribute.

Getting Started

To get started with quantflow’s codebase, take the following steps:

• Clone the repo

git clone git@github.com:quantmind/quantflow.git

• Install dev dependencies

make install-dev

• Run tests

make tests

• Run the jupyter notebook server during development

make notebook

Documentation

The documentation is built using Jupyter book which supports an extended version of Jupyter Markdown called “MyST Markdown”. For information about the MyST syntax and how to use it, see the MyST-Parser documentation.

To build the documentation website

make book

Navigate to the notebook/_build/html directory to find the index.html file you can open on your browser.

Notebooks

To run the notebooks you can use the provided make command.

make notebook

This will start a jupyter notebook server and open the browser with the notebook interface. You will be able to run the notebooks and see the results interactively (the book doesn’t have interactive widgets).

Developing with VS code

If you develop with VS code we provide several tooling for easing developing.

• Notebooks development: you can use the provided tasks to synchronize notebooks with markdown myst files by Ctrl+Shift+B. This allows to interact with the notebooks on VS code rather than jupyter interface.