# Instructions

See [Code Style](./code-style.md) for coding style guidelines.

Read and understand python files in `quantlib/definition` folder.

[quantlib/definition/bar.py](../../quantlib/definition/bar.py) contains definition for bars, and a list of bars (i.e. representation of stock history).

[quantlib/definition/line.py](../../quantlib/definition/line.py) contains definition for lines (i.e. could be used as technical indicators).

[quantlib/definition/result.py](../../quantlib/definition/result.py) contains definition for analysis results.

## Usage

If code is not run within the root of the repo, make sure the `PYTHONPATH` is set to the root of the repo. IDEs like Pycharm will do this automatically, but VSCode won't.

See `main.py` for basic usage.

### Analysis Loader

The sample code for loading the analysis data can be found in [quantlib/dataloading/remote_loader.py](../../quantlib/dataloading/remote_loader.py).