Discvar

Discvar is a Python library for discrete variable representation (DVR)

Documentation

https://kenhino.github.io/Discvar/

Installation

Minimum runtime

• The easiest way to install discvar is to use pip.

  For instance, prepare Python 3.10 or later and execute

  $ python -m venv discvar-env
  $ source discvar-env/bin/activate
  $ pip install git+https://github.com/KenHino/Discvar

For developing

• we recommend install discvar from source using uv

  $ git clone https://github.com/KenHino/Discvar.git
  $ cd Discvar
  $ uv version
  uv 0.4.18 (7b55e9790 2024-10-01)
  $ uv sync

  Then, you can execute discvar by

  $ uv run python xxx.py

  or

  $ source .venv/bin/activate
  $ python
  >>> import discvar

  For jupyter notebook tutorials, you can use

  $ uv run jupyter lab

  $ cd tests/build
  $ uv run pytest ..

  You should install pre-commit hooks including ruff formatting and linting, mypy type checking, pytest testing, and so on.

  $ uv run pre-commit install
  $ git add .
  $ uv run pre-commit

  Before push, you must fix problems!!

  Please feel free to give us feedback or pull requests.