Skip to content

Cytnx-dev/cytnx-core

Repository files navigation

Cytnx-core

This is the core compoment of the cytnx library

Develop

Package Management

We use uv to manage the package.

    uv sync --all-extras --dev

To trigger recompile of C++ code:

    uv sync --reinstall

In addition, pre-commit tool should be installed

    uv run pre-commit install

Running pytest:

    uv run pytest

Building Dependency:

  • c++ compiler
  • cmake 3.15+ (see CMakeList.txt, default 3.20)
  • most of the deps should be able to install via pypi.

GPU:

  • CUDA Toolit

Compile directly the C++ package

   $mkdir build
   $cd build
   $cmake ../ -DCMAKE_INSTALL_PREFIX=<install destination>

For DEV:

  1. Please add corresponding .pyi for binded objects/modules to comply with linting.