simlar 1.0.0__tar.gz

simlar-1.0.0/LICENSE

@@ -0,0 +1,182 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and incorporated
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any Contribution
+      incorporated within the Work constitutes direct or contributory patent
+      infringement, then any patent licenses granted to You under this License
+      for that Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative Works
+          a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works that
+          You distribute, all copyright, patent, trademark, and attribution
+          notices from the Source form of the Work, excluding those notices
+          that do not pertain to any part of the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file, You must include a
+          readable copy of the attribution notices contained within such
+          NOTICE file, in at least one of the following places: within a
+          NOTICE text file distributed as part of the Derivative Works;
+          within the Source form or documentation, if provided along with
+          the Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License. You
+          may add Your own attribution notices within Derivative Works that
+          You distribute, alongside or as an addendum to the NOTICE text
+          from the Work, provided that such additional attribution notices
+          cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Contribution, either on an original basis or as part of Derivative
+      Works, and to sublicense such rights to third parties under the terms
+      of this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions. Notwithstanding
+      the above, nothing herein shall supersede or modify the terms of any
+      separate license agreement you may have executed with Licensor regarding
+      such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 TekDatum
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

simlar-1.0.0/NOTICE

@@ -0,0 +1,21 @@
+sim_LAR — Open Wrapper and SDK
+Copyright 2024-2026 TekDatum
+
+This product includes software developed by TekDatum and its contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use this file except in compliance with the License. You may obtain a copy of
+the License at:
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+----------------------------------------------------------------------
+Third-party components
+----------------------------------------------------------------------
+
+This software depends on or redistributes the following third-party
+components, each under its own license. Dependencies that pip installs
+separately generally do not require listing here; bundled or vendored
+code does. Verify with a license scan before each release.
+
+- NumPy (BSD-3-Clause) — https://numpy.org

simlar-1.0.0/PKG-INFO

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: simlar
+Version: 1.0.0
+Summary: High-performance similarity search — open-source Python wrapper
+Author-email: TekDatum <hello@tekdatum.com>
+License: Apache-2.0
+Project-URL: Homepage, https://tekdatum.com/products/
+Project-URL: Source, https://github.com/tekdatum/simlar
+Project-URL: Documentation, https://github.com/tekdatum/simlar/blob/main/docs/index.md
+Project-URL: Issue Tracker, https://github.com/tekdatum/simlar/issues
+Project-URL: Changelog, https://github.com/tekdatum/simlar/blob/main/CHANGELOG.md
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy<2.5,>=1.24
+Provides-Extra: langchain
+Requires-Dist: langchain-core>=0.2; extra == "langchain"
+Provides-Extra: haystack
+Requires-Dist: haystack-ai>=2.0; extra == "haystack"
+Provides-Extra: llama-index
+Requires-Dist: llama-index-core>=0.10; extra == "llama-index"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: numpy<2.5,>=1.24; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Dynamic: license-file
+
+# sim_LAR
+
+Python search library combining keyword, semantic, and hybrid search into a single ranked result list — with first-class LangChain, LlamaIndex, and Haystack support.
+---
+
+## Installation
+
+The open wrapper  and the engine is on public PyPI:
+
+```bash
+pip install simlar
+```
+
+
+```bash
+pip install simlar-engine
+```
+
+## Quick start
+
+### Keyword search
+
+No embeddings required. Index your text and search.
+
+```python
+from simlar import RelevanceIndex
+
+corpus = [
+    "cancer treatment with immunotherapy",
+    "machine learning transformers",
+    "climate change renewable energy",
+]
+ids = [f"doc_{i}" for i in range(len(corpus))]
+
+idx = RelevanceIndex()
+idx.add(ids=ids, texts=corpus)
+
+results = idx.search("immunotherapy clinical trial", k=1)
+for r in results:
+    print(r.rank, r.id, f"{r.score:.4f}")
+```
+
+### Semantic search
+
+Provide pre-computed embedding vectors alongside your document IDs.
+
+```python
+import numpy as np
+from simlar import SimlarEngine
+
+# vectors: (n_docs, dim) float32, ideally L2-normalised
+vectors = np.load("corpus_embeddings.npy")
+ids     = [f"doc_{i}" for i in range(len(vectors))]
+
+idx = SimlarEngine()
+idx.add(ids=ids, vectors=vectors)
+
+query_vec = np.load("query_embedding.npy")  # shape (1, dim)
+results = idx.search(query_vec, k=5)
+for r in results:
+    print(r.rank, r.id, f"{r.score:.4f}")
+```
+
+### Hybrid search
+
+Combine keyword relevance and semantic similarity into one ranked list.
+
+```python
+import numpy as np
+from simlar import HelixIndex, RelevanceIndex, SimlarEngine, ReciprocalRankFusion
+
+corpus  = ["cancer treatment with immunotherapy", "machine learning transformers", ...]
+ids     = [f"doc_{i}" for i in range(len(corpus))]
+vectors = np.load("corpus_embeddings.npy")  # shape (n, dim)
+
+index = HelixIndex(
+    text_index=RelevanceIndex(),
+    vector_index=SimlarEngine(),
+    fusion=ReciprocalRankFusion(),
+    top_k=20,
+)
+index.add(ids=ids, texts=corpus, vectors=vectors)
+
+query_vec = np.load("query_embedding.npy")
+results = index.search(
+    query_text="immunotherapy clinical trial",
+    query_vector=query_vec,
+    k=10,
+)
+for r in results:
+    print(r.rank, r.id, f"{r.score:.4f}")
+```
+
+## Framework integrations
+
+sim_LAR works as a drop-in component in:
+
+- **LangChain** — [docs/examples/04_langchain_integration.ipynb](docs/examples/04_langchain_integration.ipynb)
+- **LlamaIndex** — [docs/examples/06_llamaindex_integration.ipynb](docs/examples/06_llamaindex_integration.ipynb)
+- **Haystack** — [docs/examples/05_haystack_integration.ipynb](docs/examples/05_haystack_integration.ipynb)
+
+## Index types at a glance
+
+| Index | Best for |
+|-------|----------|
+| `RelevanceIndex` | Keyword search over text — no embeddings required |
+| `SimlarEngine` | Semantic search over pre-computed embedding vectors |
+| `HelixIndex` | Both signals combined; corpus fits in memory |
+| `StreamingHybridIndex` | Both signals; very large corpora added in batches |
+
+## Producing embeddings
+
+sim_LAR is model-agnostic — it accepts any `(n, dim)` float32 NumPy array. Use whichever embedding library fits your project. Example with [sentence-transformers](https://sbert.net/):
+
+```bash
+pip install sentence-transformers
+```
+
+```python
+from sentence_transformers import SentenceTransformer
+
+model = SentenceTransformer("WhereIsAI/UAE-Large-V1")
+
+corpus_vectors = model.encode(corpus, normalize_embeddings=True)   # (n, dim) float32
+query_vec      = model.encode(["my search query"], normalize_embeddings=True)  # (1, dim)
+```
+
+## Saving and loading indexes
+
+Every index type shares the same save/load interface.
+
+```python
+# Save
+index.save("/path/to/dir")
+
+# Load (type is detected automatically)
+from simlar import load_from_directory
+index = load_from_directory("/path/to/dir")
+```
+
+## Extending sim_LAR
+
+Register a custom index class to make it compatible with `load_from_directory()` and the rest of the library:
+
+```python
+from simlar import VectorIndex, register
+
+@register("my_index")
+class MyIndex(VectorIndex):
+    ...
+```
+
+## Contributing
+
+Contributions to simlar are welcome. Because this is a dual-licensed open-core project, we require all contributors to agree to a [Contributor License Agreement (CLA)](./CONTRIBUTING.md) before we can merge. This lets us keep the open-core model viable and continue offering simlar under Apache 2.0. See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
+
+We do not accept contributions to the proprietary engine.
+
+## Trademarks
+
+"sim_LAR", "TekDatum", and associated logos are trademarks of TekDatum. The Apache 2.0 license for the open code does **not** grant rights to use these marks. You may build on and redistribute the open code, but you may not use our names or logos in a way that implies endorsement or that misrepresents the origin of a fork. See [TRADEMARKS.md](./TRADEMARKS.md).
+
+## Documentation
+
+| Document | Description |
+|----------|-------------|
+| [Concepts](docs/concepts.md) | Architecture and design decisions |
+| [API Reference](docs/concepts.md) | Full public API |
+| [Examples](docs/examples/) | Runnable scripts |
+
+## License
+
+- The contents of this repository are licensed under the **Apache License, Version 2.0** — see [LICENSE](./LICENSE).
+- The proprietary `simlar-engine` binary is licensed under a **Commercial EULA** — see [EULA.md](./EULA.md).
+- Third-party components and their licenses are listed in [NOTICE](./NOTICE).
+
+## License Boundary
+
+This project uses an **open-core** model. It has two layers with **different licenses**:
+
+| Layer | Package | License | Where it lives |
+|---|---|---|---|
+| **Open wrapper + SDK** | `simlar` | Apache License 2.0 | This repo · public PyPI |
+| **Proprietary engine** | `simlar-engine` | Commercial EULA (closed binary) | public PyPI |
+
+**What this means in practice:**
+
+- The code **in this repository** is free and open under Apache 2.0. You can read it, fork it, modify it, and build on it, including commercially, subject to the Apache 2.0 terms.
+- The wrapper depends on a **separate, proprietary binary package** (`simlar-engine`) that contains TekDatum's core IP. That binary is **not** open source. Installing and using it requires accepting the [Commercial EULA](./EULA.md) and, for production use, a license from TekDatum.
+- Calling the proprietary engine through this open SDK does **not** make your own code subject to the EULA — your application code is yours. The EULA governs only the proprietary binary itself.
+
+If you only want to read or contribute to the open layer, you never need a license. If you want to **run** the full product, you need the engine.
+
+## What's open and what's not
+
+**Open (Apache 2.0, in this repo):**
+- The SDK and public API surface (`RelevanceIndex`, `HelixIndex`, `StreamingHybridIndex`, `ReciprocalRankFusion`)
+- Framework adapters (LangChain / LlamaIndex / Haystack)
+- The `load_from_directory()` loader and `@register` extension API
+- Configuration schema, type stubs, examples, and docs
+
+**Proprietary (Commercial EULA, separate binary):**
+- The core `SimlarEngine` vector search implementation
+- Compiled ranking and retrieval algorithms
+
+We keep this boundary deliberate and documented so you always know which terms apply to which code.
+
+---
+
+© 2026 TekDatum.

simlar-1.0.0/README.md

@@ -0,0 +1,210 @@
+# sim_LAR
+
+Python search library combining keyword, semantic, and hybrid search into a single ranked result list — with first-class LangChain, LlamaIndex, and Haystack support.
+---
+
+## Installation
+
+The open wrapper  and the engine is on public PyPI:
+
+```bash
+pip install simlar
+```
+
+
+```bash
+pip install simlar-engine
+```
+
+## Quick start
+
+### Keyword search
+
+No embeddings required. Index your text and search.
+
+```python
+from simlar import RelevanceIndex
+
+corpus = [
+    "cancer treatment with immunotherapy",
+    "machine learning transformers",
+    "climate change renewable energy",
+]
+ids = [f"doc_{i}" for i in range(len(corpus))]
+
+idx = RelevanceIndex()
+idx.add(ids=ids, texts=corpus)
+
+results = idx.search("immunotherapy clinical trial", k=1)
+for r in results:
+    print(r.rank, r.id, f"{r.score:.4f}")
+```
+
+### Semantic search
+
+Provide pre-computed embedding vectors alongside your document IDs.
+
+```python
+import numpy as np
+from simlar import SimlarEngine
+
+# vectors: (n_docs, dim) float32, ideally L2-normalised
+vectors = np.load("corpus_embeddings.npy")
+ids     = [f"doc_{i}" for i in range(len(vectors))]
+
+idx = SimlarEngine()
+idx.add(ids=ids, vectors=vectors)
+
+query_vec = np.load("query_embedding.npy")  # shape (1, dim)
+results = idx.search(query_vec, k=5)
+for r in results:
+    print(r.rank, r.id, f"{r.score:.4f}")
+```
+
+### Hybrid search
+
+Combine keyword relevance and semantic similarity into one ranked list.
+
+```python
+import numpy as np
+from simlar import HelixIndex, RelevanceIndex, SimlarEngine, ReciprocalRankFusion
+
+corpus  = ["cancer treatment with immunotherapy", "machine learning transformers", ...]
+ids     = [f"doc_{i}" for i in range(len(corpus))]
+vectors = np.load("corpus_embeddings.npy")  # shape (n, dim)
+
+index = HelixIndex(
+    text_index=RelevanceIndex(),
+    vector_index=SimlarEngine(),
+    fusion=ReciprocalRankFusion(),
+    top_k=20,
+)
+index.add(ids=ids, texts=corpus, vectors=vectors)
+
+query_vec = np.load("query_embedding.npy")
+results = index.search(
+    query_text="immunotherapy clinical trial",
+    query_vector=query_vec,
+    k=10,
+)
+for r in results:
+    print(r.rank, r.id, f"{r.score:.4f}")
+```
+
+## Framework integrations
+
+sim_LAR works as a drop-in component in:
+
+- **LangChain** — [docs/examples/04_langchain_integration.ipynb](docs/examples/04_langchain_integration.ipynb)
+- **LlamaIndex** — [docs/examples/06_llamaindex_integration.ipynb](docs/examples/06_llamaindex_integration.ipynb)
+- **Haystack** — [docs/examples/05_haystack_integration.ipynb](docs/examples/05_haystack_integration.ipynb)
+
+## Index types at a glance
+
+| Index | Best for |
+|-------|----------|
+| `RelevanceIndex` | Keyword search over text — no embeddings required |
+| `SimlarEngine` | Semantic search over pre-computed embedding vectors |
+| `HelixIndex` | Both signals combined; corpus fits in memory |
+| `StreamingHybridIndex` | Both signals; very large corpora added in batches |
+
+## Producing embeddings
+
+sim_LAR is model-agnostic — it accepts any `(n, dim)` float32 NumPy array. Use whichever embedding library fits your project. Example with [sentence-transformers](https://sbert.net/):
+
+```bash
+pip install sentence-transformers
+```
+
+```python
+from sentence_transformers import SentenceTransformer
+
+model = SentenceTransformer("WhereIsAI/UAE-Large-V1")
+
+corpus_vectors = model.encode(corpus, normalize_embeddings=True)   # (n, dim) float32
+query_vec      = model.encode(["my search query"], normalize_embeddings=True)  # (1, dim)
+```
+
+## Saving and loading indexes
+
+Every index type shares the same save/load interface.
+
+```python
+# Save
+index.save("/path/to/dir")
+
+# Load (type is detected automatically)
+from simlar import load_from_directory
+index = load_from_directory("/path/to/dir")
+```
+
+## Extending sim_LAR
+
+Register a custom index class to make it compatible with `load_from_directory()` and the rest of the library:
+
+```python
+from simlar import VectorIndex, register
+
+@register("my_index")
+class MyIndex(VectorIndex):
+    ...
+```
+
+## Contributing
+
+Contributions to simlar are welcome. Because this is a dual-licensed open-core project, we require all contributors to agree to a [Contributor License Agreement (CLA)](./CONTRIBUTING.md) before we can merge. This lets us keep the open-core model viable and continue offering simlar under Apache 2.0. See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
+
+We do not accept contributions to the proprietary engine.
+
+## Trademarks
+
+"sim_LAR", "TekDatum", and associated logos are trademarks of TekDatum. The Apache 2.0 license for the open code does **not** grant rights to use these marks. You may build on and redistribute the open code, but you may not use our names or logos in a way that implies endorsement or that misrepresents the origin of a fork. See [TRADEMARKS.md](./TRADEMARKS.md).
+
+## Documentation
+
+| Document | Description |
+|----------|-------------|
+| [Concepts](docs/concepts.md) | Architecture and design decisions |
+| [API Reference](docs/concepts.md) | Full public API |
+| [Examples](docs/examples/) | Runnable scripts |
+
+## License
+
+- The contents of this repository are licensed under the **Apache License, Version 2.0** — see [LICENSE](./LICENSE).
+- The proprietary `simlar-engine` binary is licensed under a **Commercial EULA** — see [EULA.md](./EULA.md).
+- Third-party components and their licenses are listed in [NOTICE](./NOTICE).
+
+## License Boundary
+
+This project uses an **open-core** model. It has two layers with **different licenses**:
+
+| Layer | Package | License | Where it lives |
+|---|---|---|---|
+| **Open wrapper + SDK** | `simlar` | Apache License 2.0 | This repo · public PyPI |
+| **Proprietary engine** | `simlar-engine` | Commercial EULA (closed binary) | public PyPI |
+
+**What this means in practice:**
+
+- The code **in this repository** is free and open under Apache 2.0. You can read it, fork it, modify it, and build on it, including commercially, subject to the Apache 2.0 terms.
+- The wrapper depends on a **separate, proprietary binary package** (`simlar-engine`) that contains TekDatum's core IP. That binary is **not** open source. Installing and using it requires accepting the [Commercial EULA](./EULA.md) and, for production use, a license from TekDatum.
+- Calling the proprietary engine through this open SDK does **not** make your own code subject to the EULA — your application code is yours. The EULA governs only the proprietary binary itself.
+
+If you only want to read or contribute to the open layer, you never need a license. If you want to **run** the full product, you need the engine.
+
+## What's open and what's not
+
+**Open (Apache 2.0, in this repo):**
+- The SDK and public API surface (`RelevanceIndex`, `HelixIndex`, `StreamingHybridIndex`, `ReciprocalRankFusion`)
+- Framework adapters (LangChain / LlamaIndex / Haystack)
+- The `load_from_directory()` loader and `@register` extension API
+- Configuration schema, type stubs, examples, and docs
+
+**Proprietary (Commercial EULA, separate binary):**
+- The core `SimlarEngine` vector search implementation
+- Compiled ranking and retrieval algorithms
+
+We keep this boundary deliberate and documented so you always know which terms apply to which code.
+
+---
+
+© 2026 TekDatum.