FAQ & Contributing¶

Frequently asked questions¶

Do I need to install Learn-Quant as a package?

No. It is a collection of standalone folders. Clone the repo, install the requirements once, and run any module directly.

Which Python version should I use?

Python 3.9+ works for every module. CI runs on 3.11.

Some modules import scipy / scikit-learn — are those required?

They are listed in requirements.txt. A handful of modules use them for optimisation or ML; the README of each module notes any extra dependency.

Can I use this code in my own project?

Yes — it is MIT licensed. It is written for learning, so audit and adapt before putting anything near real capital.

How do I run the JavaScript modules?

Install Node.js 18+ and run node <file>.js inside the module folder.

Is any of this investment advice?

No. Everything here is educational. Markets carry risk; do your own research.

Contributions are very welcome.

Found a bug? Open an issue.
Have a new module or strategy? Fork the repo and open a pull request.
Improving the docs? Edit the relevant module README.md — the site rebuilds automatically.

A good module folder contains:

A README.md with theory → formula → usage → pitfalls.
A single-purpose .py implementation with type hints and a runnable __main__ demonstration.
A matching test in z_tests/ (test_<module>.py).

Before opening a PR:

ruff check .
ruff format .
pytest z_tests -q
python docs_builder.py   # regenerate the site

Thanks for helping more people learn quant.