{"id":13690994,"url":"https://github.com/kxsystems/jupyterq","last_synced_at":"2025-04-12T21:23:49.490Z","repository":{"id":47234443,"uuid":"119595892","full_name":"KxSystems/jupyterq","owner":"KxSystems","description":"Jupyter kernel for kdb+","archived":false,"fork":false,"pushed_at":"2025-04-04T15:19:55.000Z","size":1839,"stargazers_count":111,"open_issues_count":14,"forks_count":46,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-12T03:14:12.507Z","etag":null,"topics":["embedpy","jupyter","jupyter-kernels","kdb","notebook","python","q"],"latest_commit_sha":null,"homepage":"https://code.kx.com/q/interfaces","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KxSystems.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-01-30T21:20:37.000Z","updated_at":"2025-03-15T23:38:54.000Z","dependencies_parsed_at":"2023-11-20T16:53:57.380Z","dependency_job_id":null,"html_url":"https://github.com/KxSystems/jupyterq","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KxSystems%2Fjupyterq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KxSystems%2Fjupyterq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KxSystems%2Fjupyterq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KxSystems%2Fjupyterq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KxSystems","download_url":"https://codeload.github.com/KxSystems/jupyterq/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248632750,"owners_count":21136749,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["embedpy","jupyter","jupyter-kernels","kdb","notebook","python","q"],"created_at":"2024-08-02T17:00:38.204Z","updated_at":"2025-04-12T21:23:49.466Z","avatar_url":"https://github.com/KxSystems.png","language":"Jupyter Notebook","funding_links":[],"categories":[":fireworks: Fusion interfaces"],"sub_categories":[],"readme":"# JupyterQ\n\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/kxsystems/jupyterq)](https://github.com/kxsystems/jupyterq/releases) [![Travis (.org) branch](https://img.shields.io/travis/kxsystems/jupyterq/master?label=travis%20build)](https://travis-ci.com/kxsystems/jupyterq/branches) [![AppVeyor branch](https://img.shields.io/appveyor/ci/jhanna-kx/jupyterq-opbu8/master?label=appveyor%20build)](https://ci.appveyor.com/project/jhanna-kx/jupyterq-opbu8/branch/master)\n\nJupyter kernel for kdb+. Features include\n\n-   syntax highlighting for q\n-   code completion for q keywords, `.z`/`.h`/`.Q`/`.j` namespace functions, and user-defined variables\n-   code help for q keywords and basic help (display and type information) for user-defined objects\n-   script-like execution of code (multiline input)\n-   inline display of charts created using `embedPy` and `matplotlib`\n-   console stdout/stderr capture and display in notebooks\n-   inline loading and saving of scripts into and from notebook cells\n\n\n## Requirements\n\n- kdb+ ≥ v3.5 64-bit\n- Python ≥ 3.6\n- [embedPy](https://github.com/KxSystems/embedPy)\n\n**Note:**\n\nAs of September 5, 2020. Python 3.5 has reached end of life as indicated [here](https://www.python.org/downloads/release/python-3510/). As such official support for this Python Version has been removed in favour of updates to support Python 3.8.\n\n## Overview\n\nYou can either\n\n-   install JupyterQ to run on your local machine; or\n-   download or build a Docker image in which to run JupyterQ\n\nThere are two ways to install JupyterQ on your local machine:\n\n1.  download and install a release\n1.  install with Conda – recommended if you are already using Anaconda Python\n\n\n## Install on local machine\n\n\u003ca id='download-and-install-a-release'\u003e\u003c/a\u003e\n### Download and install a release\n\n1.  Make sure you have installed [embedPy](https://github.com/KxSystems/embedPy)\n\n1.  Download a release archive from the [releases](../../releases/latest) page, and unzip it.\n\n1.  Install the required Python packages with Pip or Conda\n\n    ```bash\n    # pip\n    pip install -r requirements.txt\n    # conda\n    conda install --file requirements.txt\n    ```\n\n1. Ensure `QHOME` is set and you have a working version of q in your `PATH`. Note that Jupyter will not pick up Bash aliases when starting q: the location of the q executable needs to be in your `PATH`.\n\n1. Run the install script\n\n    Linux/macOS\n\n    ```bash\n    ./install.sh\n    ```\n    Windows\n    ```\n    install.bat\n    ```\n\n\n### Install with Conda\n\n1.  [Download and install](https://conda.io/docs/user-guide/install/download.html) either the full Anaconda distribution or Miniconda for Python3.\n\n2.  Use Conda to install JupyterQ and its dependencies\n\n    ```bash\n    conda install -c kx jupyterq\n    ```\n\n3. Ensure you can run q _before_ running JupyterQ for the first time. You may need to obtain an on-demand licence\n\n  ```bash\n  q\n  …\n  q)\\\\\n  ```\n---\n**_NOTE_**\n\nIf installing on a system which already has kdb+ we recommended installing JupyterQ, embedPy and the conda packaged version of kdb+ in a conda environment, this can be done using the following steps\n\n```bash\n# create a new environment and install jupyterq and its dependancies\nconda create -n jupyterqenv -c kx jupyterq\n# activate the environment for use\nconda activate jupyterqenv\n```\n\nIt should be noted that in this case JupyterQ, embedPy and the conda installed kdb can only be run from this activated environment.\n\n---   \n## Running after install\n\nTo run the Jupyter console\n\n```bash\njupyter console --kernel=qpk\n```\n\nTo run the example notebook\n\n```bash\njupyter notebook kdb+Notebooks.ipynb\n```\n\n\n## Run a Docker image\n\nIf you have [Docker installed](https://www.docker.com/community-edition) you can alternatively run:\n\n```bash\ndocker run -it --name myjupyterq -p 8888:8888 kxsys/jupyterq\n```\n\nNow point your browser at \u003chttp://localhost:8888/notebooks/kdb%2BNotebooks.ipynb\u003e.\n\nFor subsequent runs, you will not be prompted to redo the license setup when calling:\n\n```bash\ndocker start -ai myjupyterq\n```\n\nTo change the port or use the image to run your own notebooks, see the Docker [README](docker/README.md#runoptions).\n\nSee [instructions regarding headless/presets](https://github.com/KxSystems/embedPy/blob/master/docker/README.md#headlesspresets).\n\nSee [build instructions for the image](docker/README.md).\n\n\n## Using notebooks\n\nSee the notebook `kdb+Notebooks.ipynb` for full interactive examples and explanation. (It should be legible on GitHub.)\n\n\n## Documentation\n\nSee documentation on the [JupyterQ](https://code.kx.com/v2/ml/jupyterq/) homepage.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkxsystems%2Fjupyterq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkxsystems%2Fjupyterq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkxsystems%2Fjupyterq/lists"}