Metadata-Version: 2.1
Name: quantumtools
Version: 0.1.3
Summary: 
License: GPL-3.0-or-later
Author: Stanley Wang
Author-email: s.wang4331@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: matplotlib (>=3.1.3,<4.0.0)
Requires-Dist: pandas (>=1.0.0,<2.0.0)
Requires-Dist: scikit-learn (>=1.0.0,<2.0.0)
Description-Content-Type: text/markdown

# quantumtools

machine learning utilities

## User Setup
1. `pip install quantumtools`

## Development setup

1. **Note** prepend `py -3.8 -m` if there are different pythonv versions
1. Install poetry
    1. `pip install poetry` # develop in python 3.8
1. **Note** in windows and vscode, need to ensure vscode env path is 
    1. `~/.virtualenvs` 
    1. `"python.venvPath": "~/.virtualenvs"` in settings.json
    1. and `py -3.8 -m poetry config virtualenvs.in-project false`
    1. `py -3.8 -m poetry config virtualenvs.path "~\.virtualenvs"`
1. to recreate env with updated pyproject.toml
    1. enter python env with `py -3.8 -m poetry shell`
    1. `update_env.bat`
    1. `pytest` # to run test
1. to add dependencies
    1. enter python env `py -3.8 -m poetry shell`
    1. `poetry add packagename@^#.#.#` , @ is for version increase
    1. for development dependencies `poetry add --group dev packagename@^#.#.#` 

## Dev Reference

1. Generate pyproject.toml interactively and create venv
1. poetry init  or poetry new packagename
1. Add dependency
    1. poetry add requests # Add --group dev for development dependencies
1. Install dependencies into venv
    1. poetry install
1. Activate venv
    1. poetry shell
1. Exit venv
    1. exit

1. **NOTE**, to add for installs from github, use `poetry2setup > setup.py`

