Giter Club home page Giter Club logo

discvar's Introduction

unittest-poetry Static Badge

Discvar

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

Documentation

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

Installation

Clone this repository to your local environment;

$ git clone https://github.com/KenHino/Discvar.git
$ cd Discvar

Before installation, please make sure you have the following requirements:

  • Python 3.10 or later If you don't have Python, you can install it by e.g. pyenv.

    $ pyenv install $(cat .python-version)
  • pipx

    pip is a general-purpose package installer for both libraries and apps with no environment isolation. pipx is made specifically for application installation, as it adds isolation yet still makes the apps available in your shell: pipx creates an isolated environment for each application and its associated packages.

  • poetry

    $ pipx install poetry==$(cat .poetry-version)

Install by poetry;

$ poetry install --with dev

If you need only minimum requirements, remove --with dev. If you want to install documentation, change it to --with dev,docs.

Then, you can use Discvar by

$ poetry run python xxx.py

or

$ poetry shell
$ python
>>> import discvar
$ exit

F.Y.I.,

pytest is also installed by poetry install --with dev.

$ poetry run pytest

For developers,

you should install pre-commit hooks.

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

Before push you must fix problems!!

$ make

also support you.

discvar's People

Contributors

kenhino avatar github-actions[bot] avatar

Watchers

 avatar

Forkers

qclovers

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.