Getting Started#

Installation#

Verbs can be installed via pip

pip install verbs

Building verbs requires a rust and cargo installation see here for instructions.

Verbs uses hatch for dependency control, see the hatch docs for installation instructions.

Note

OSX users may need to install patchelf with homebrew using

brew install patchelf

Using hatch the package can be built by running

hatch run dev:build

from the repo root, which will build the package to target/

If you want to start a Jupyter Notebook with verbs installed you can run

hatch run notebook:jupyter

which will build the package and start a jupyter server.

Verbs can be added as a github dependency in the pyproject.toml

dependencies = [
   "verbs@git+ssh://git@github.com/simtopia/verbs.git"
]

but also requires that maturin is added as a build requirement, for example

[build-system]
requires = ["setuptools >= 61.0", "maturin>=1.2,<2.0"]
build-backend = "setuptools.build_meta"