Documentation for qp_flexzboost
The qp_flexzboost package allows for efficient, lossless storage of
Flexcode [1] [2]
conditional density estimates. It acts as an extension of qp
and utilizes the functionality provided there.
It will typically be used as a transparent shim between qp, and rail-flexzboost.
For detailed comparison of the performance of this package relative to built in
qp representations, please see the
performance comparison.
Getting Started
The easiest way to install it is with pip.
>> pip install qp-flexzboost
Alternatively, the source code can be cloned from GitHub.
>> git clone git@github.com:LSSTDESC/qp_flexzboost.git
>> cd qp_flexzboost
>> pip install -e .
>> pip install .'[dev]' # Only required for development and contributions
This package is open source and uses the MIT license.
Usage
For the minimal usage take a look at this minimal notebook.
Additional notebooks providing a general overview of usage can be found here.
Note that this package will typically be used in conjunction with RAIL, qp, and rail-flexzboost.