Skip to content

Commit

Permalink
Merge branch 'main' into KXI-43682
Browse files Browse the repository at this point in the history
  • Loading branch information
rianoc-kx authored Jun 11, 2024
2 parents 79c30fc + de7966c commit 8c317cb
Show file tree
Hide file tree
Showing 79 changed files with 4,514 additions and 1,004 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,11 @@ __pycache__/
!e.*
!libkurl.*
!libobjstor.*
**/4-1-libs/*.q
**/4-1-libs/*.q_
**/4-1-libs/*.k_
**/4-1-libs/*.k
!**/4-1-libs/q.k

# Distribution / packaging
.Python
Expand Down Expand Up @@ -223,6 +228,8 @@ coverage.xml

# CCLS files
.ccls-cache/*
.ccls
compile_commands.json

# HDB Test files
HDB/**
Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,19 @@ For more information on using q/kdb+ and getting started with see the following

Ensure you have a recent version of pip:

```bash
pip install --upgrade pip

```

Then install the latest version of PyKX with the following command:

```
```bash
pip install pykx
```

To install a specific version of PyKX run the following command replacing <INSERT_VERSION> with a specific released semver version of the interface

```
```bash
pip install pykx==<INSERT_VERSION>
```

Expand All @@ -68,9 +69,9 @@ The following steps outline the process by which a user can gain access to an in

#### Commercial Evaluation License

The following steps outline the process by which a user can gain access to an install a kdb Insights license which provides access to PyKX
The following steps outline the process by which a user can gain access to an install a kdb Insights license which provides access to PyKX

1. Visit https://kx.com/kdb-insights-commercial-evaluation-license-download/ and fill in the attached form following the instructions provided.
1. Contact you KX sales representative or sales@kx.com requesting a trial license for PyKX evaluation. Alternately apply through https://kx.com/book-demo.
2. On receipt of an email from KX providing access to your license download this file and save to a secure location on your computer.
3. Set an environment variable on your computer pointing to the folder containing the license file (instructions for setting environment variables on PyKX supported operating systems can be found [here](https://chlee.co/how-to-setup-environment-variables-for-windows-mac-and-linux/).
* Variable Name: `QLIC`
Expand Down Expand Up @@ -107,6 +108,8 @@ When using PyKX with KX Dashboards users will be required to install `ast2json~=

When using PyKX Beta features users will be required to install `dill>=0.2.0` this can be installed using the `beta` extra, e.g. `pip install pykx[beta]`

When using Streamlit users will be required to install `streamlit~=1.28` this can be installed using the `streamlit` extra, e.g. `pip install pykx[streamlit]`

**Warning:** Trying to use the `pa` conversion methods of `pykx.K` objects or the `pykx.toq.from_arrow` method when PyArrow is not installed (or could not be imported without error) will raise a `pykx.PyArrowUnavailable` exception. `pyarrow` is supported Python 3.8-3.10 but remains in Beta for Python 3.11.

#### Optional Non-Python Dependencies
Expand Down
11 changes: 11 additions & 0 deletions custom_theme/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,15 @@
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-PG938LS');</script>
<!-- End Google Tag Manager -->
<!-- Delighted Survey tool -->
<script type="text/javascript">
!function(e,t,r,n){if(!e[n]){for(var a=e[n]=[],i=["survey","reset","config","init","set","get","event","identify","track","page","screen","group","alias"],s=0;s<i.length;s++){var c=i[s];a[c]=a[c]||function(e){return function(){var t=Array.prototype.slice.call(arguments);a.push([e,t])}}(c)}a.SNIPPET_VERSION="1.0.1";var o=t.createElement("script");o.type="text/javascript",o.async=!0,o.src="https://d2yyd1h5u9mauk.cloudfront.net/integrations/web/v1/library/"+r+"/"+n+".js";var p=t.getElementsByTagName("script")[0];p.parentNode.insertBefore(o,p)}}(window,document,"QKBtsIp633c7g2I2","delightedThumbsP");

delightedThumbsP.survey({
properties: { // extra context (optional)
product: "PyKX"
}
});
</script>
<!-- End Delighted Survey tool -->
{% endblock %}
Loading

0 comments on commit 8c317cb

Please sign in to comment.