https://github.com/kxsystems/ax
https://github.com/kxsystems/ax
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/kxsystems/ax
- Owner: KxSystems
- License: apache-2.0
- Created: 2026-03-18T12:11:08.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-04-27T13:22:50.000Z (about 2 months ago)
- Last Synced: 2026-05-25T12:05:30.773Z (18 days ago)
- Language: q
- Size: 13.8 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# AX Module
The kdb-x ax module exposes components from the [ax-libraries](https://code.kx.com/developer/libraries/#q-libraries) under the modules framework. The current components that have been ported across are:
- [Grammar of Graphics](https://code.kx.com/developer/ggplot/) (ggplot)
- [qDoc](https://code.kx.com/developer/libraries/#qdoc)
## Prerequisites
Fusionx pcre2 is a required module, and needs to be callable via
```q
use`kx.fusion:pcre2
```
The install instructions for that can be found [here](https://github.com/KxSystems/fusionx/blob/main/README.md)
## Build Instructions
These instructions are for building from source, the pre-built module is available under [releases](https://github.com/KxSystems/ax/tags).
Outside of fusionx pcre2, there are two kdb-x submodules included in this repo required for ggplot specifically. These are:
- [qskia](./qskia) -> skia.$A.(so|dll)
- [qbitops](./qbitops) -> bitops.$A.(so|dll)
After building each from their respective directories, move the built shared libraries to the [ax](./ax) folder. Now it is ready to be installed.
## Installation Documentation
:point_right: [`Install guide`](docs/install.md)
## API Documentation
The APIs match the ax-libraries APIs, with the benefit of being loadable to any namespace.
```q
([qp;gg;qd]):use`kx.ax; // all components
([qd]):use`kx.ax.qdoc; // or more granularly
([qp;gg]):use`kx.ax.graphics;
```
Simply replace `.qp`, `.gg` and `.qd` with `qp`, `gg` and `qd` respectively when referencing the ax-libraries API specifications (or the namespace you have chosen to assign the components to).
:point_right: [GGPlot](https://code.kx.com/analyst/libraries/grammar-of-graphics/)
:point_right: [qDoc](https://code.kx.com/developer/libraries/documentation-generator/)