curv-python

This is a monorepo for the Curv Python packages, curv and curvtools and the shared utilities package, curvpyutils on which they both depend.

Installation

The recommended installation method is to use pipx to install curvtools CLI tools. You don't need to clone this repo.

• macOS:

   brew install pipx
   pipx ensurepath
   pipx install curvtools

• Ubuntu 22.04 LTS and later:

  sudo apt install pipx
  pipx install curvtools

• Windows and other Linux distributions: see pipx installation instructions.

Usage

Once installed with pipx, all the command line tools needed to build the Curv CPU will be in your PATH:

curv-cfg --help
curv-cache-tool --help
curv-subst --help
curv-memmap2 --help
curv-clog2 --help

These tools are called automatically by the build process for the Curv CPU. To simply get the CPU working, you really don't need to know anything about them. Just make sure they are in your PATH and you're good to go.

Contributing to curv-python

If you want to tweak the code or contribute to the project, skip the pipx install described above and instead follow the steps in the contributing guide.