polars-ocaml

🐻‍❄️❤️🐫

polars-ocaml is a project to provide idiomatic OCaml bindings to the Polars dataframe library.

Check out the ported examples from the Polars user guide for a quick tour of what you can do with polars-ocaml!

Install with opam install polars.

project status

Currently very much WIP. Please expect breakages and large changes in API.

Note that the current code assumes that the OCaml version is 4.14.1; see HACKING.md for notes on how to build polars-ocaml.

docs

odoc-generated docs are available here.

utop

polars-ocaml works in utop!

$ dune utop --profile utop[^utop-workaround]

[^utop-workaround]: The special profile is a workaround for a known limitation in a library we use).

jupyter notebook

polars-ocaml works in Jupyter notebooks, using akabe/ocaml-jupyter!

Just install the polars opam package alongside the jupyter package:

$ pip install jupyter
$ opam install jupyter polars
$ ocaml-jupyter-opam-genspec
$ jupyter kernelspec install --user --name "ocaml-jupyter-$(opam var switch)" "$(opam var share)/jupyter"

license

This project is licensed under the terms of the MIT license, with the exception of the following files:

• ./guide/data/iris.csv: the Iris dataset by R. A. Fisher is licensed under CC BY 4.0.
• ./guide/data/legislators-historical.csv: congress-legislators is licensed under CC0
• ./guide/data/pokemon.csv
• ./guide/data/appleStock.csv
• ./guide/data/reddit.csv