dnhydb 0.2.0__tar.gz

dnhydb-0.2.0/Cargo.lock

@@ -0,0 +1,188 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "adler2"
+version = "2.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "320119579fcad9c21884f5c4861d16174d0e06250625266f50fe6898340abefa"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600"
+
+[[package]]
+name = "crc32fast"
+version = "1.5.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "01a7799fd6b852db0e61728dde9a204c423b44d689dbd432522543614b490e78"
+dependencies = [
+ "cfg-if",
+]
+
+[[package]]
+name = "dnhydb-core"
+version = "0.2.0"
+dependencies = [
+ "crc32fast",
+ "libc",
+ "miniz_oxide",
+ "windows-sys",
+]
+
+[[package]]
+name = "dnhydb-py"
+version = "0.2.0"
+dependencies = [
+ "dnhydb-core",
+ "pyo3",
+]
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "libc"
+version = "0.2.190"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ce5d3ddc6d3fa000eb1536d85e147bfe31aacaba692ed6a876f95cb7c855be78"
+
+[[package]]
+name = "miniz_oxide"
+version = "0.8.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fa76a2c86f704bdb222d66965fb3d63269ce38518b83cb0575fca855ebb6316"
+dependencies = [
+ "adler2",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "05c8b63e8d9609db387f0324918f81d68fe27748f084ef092fb35954d0539a85"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.107"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "700d18fa267b73b9b521fd7e13580e2f446916f176cacee1ab63fcc8191f1655"
+dependencies = [
+ "libc",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7b3fc0c4d08f6bb10e71fe39dfb9e2f59c6eb6854e22ec8092f50c69a4499adb"
+dependencies = [
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dfc0b8e19df29aad7086cf977bb0c2a2f143e30567eb113e9cf72b62ca698330"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6100e8a4b5eba53afaa5ed078364851a0b2499c553a44c31026b929049b49dc6"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6143877a16e82b5a727b7127ff4cd86858a24a28d745d72f43e6f227c7b1bdb3"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.119"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.27"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a2c754d6c33795a1c324727428e5a7dedb5b06195f9890bdbcba760d3e246563"
+
+[[package]]
+name = "windows-link"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
+
+[[package]]
+name = "windows-sys"
+version = "0.61.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc"
+dependencies = [
+ "windows-link",
+]

dnhydb-0.2.0/Cargo.toml

@@ -0,0 +1,26 @@
+[workspace]
+resolver = "3"
+members = ["crates/dnhydb-core", "crates/dnhydb-py"]
+
+[workspace.package]
+version = "0.2.0"
+edition = "2024"
+authors = ["Achim Meissner <achim.meissner@nhydb.de>"]
+license-file = "LICENSE.md"
+publish = false
+
+[workspace.dependencies]
+crc32fast = "1.4"
+miniz_oxide = "0.8"
+libc = "0.2"
+pyo3 = "0.29"
+
+[profile.release]
+opt-level = 3
+lto = "fat"
+codegen-units = 1
+panic = "unwind"
+debug = false
+
+[profile.bench]
+inherits = "release"

dnhydb-0.2.0/LICENSE.md

@@ -0,0 +1,167 @@
+# NHyDB / dNHyDB Experimental Software License
+
+**License Version 1.0 — 17 October 2026**
+
+Copyright (c) 2026 Achim Meissner. All rights reserved.
+
+**Official website:** https://nhy-db.com  
+**Licensing contact:** achim.meissner@nhydb.de
+
+**SOURCE-AVAILABLE SOFTWARE — NOT AN OPEN-SOURCE LICENSE**
+
+This License governs both **NHyDB** and **dNHyDB** when distributed under these terms by the Licensor. Each is referred to below as a **Product**; together they are referred to as the **Software**. The same License text may be included unchanged in both repositories.
+
+The Software is provided free of charge for limited experimental purposes only. **This License grants no right to use either Product in production.**
+
+## 1. Definitions
+
+**Licensor:** Achim Meissner, to the extent he owns or controls the rights being licensed.
+
+**Licensee:** The individual or legal entity exercising the permissions of this License. When a Product is used for an organization, that organization is the Licensee; individual employees do not receive separate organizational evaluation periods.
+
+**Software:** The relevant Product's code, binaries, and accompanying materials that the Licensor distributes under this License, including modifications made under its permissions. Independently licensed third-party components remain subject to their respective terms.
+
+**Non-Production Use:** Internal, isolated testing, experimentation, evaluation, teaching, research, or development that does not operate, support, or form part of any live operational system and on which no real-world process relies.
+
+**First Use:** The first actual execution or operation of the relevant Product by or for the Licensee, including running tests or an evaluation. Merely viewing or downloading source code does not count as First Use.
+
+**Written Permission:** Express permission from the Licensor in durable written form, including email, identifying the additional permitted activity. Silence is not permission.
+
+## 2. Limited license grant
+
+Subject to compliance with this License, the Licensor grants the Licensee a non-exclusive, worldwide, non-transferable, royalty-free permission, for the applicable period in Section 3, to:
+
+1. Download, inspect, build, execute, and test the Software for authorized Non-Production Use.
+2. Make copies reasonably necessary for the Licensee's own authorized internal testing and for backups, without prejudice to mandatory statutory rights.
+3. Modify the source code and create derivative experimental versions **for the Licensee's own internal Non-Production Use only**.
+
+No sublicense, redistribution, third-party service provision, publication of modified versions, or Production Use is granted. Employees within the same legal entity may participate in its authorized internal tests. Separate entities, external contractors, clients, and other third parties do not acquire rights through the Licensee.
+
+These permissions do not affect activities expressly allowed by mandatory law.
+
+## 3. Categories and duration of free use
+
+| Licensee / purpose | Free-use period | Permitted activity |
+|---|---|---|
+| **Private individuals** | **Unlimited** | Own private, non-commercial, strictly non-production experimentation, learning, and development |
+| **Schools and universities — teaching** | **24 calendar months** | Internal non-production teaching, exercises, instruction, and educational development |
+| **Non-commercial academic or scientific research** | **6 calendar months** | Internal non-production research and evaluation |
+| **Businesses and other commercial organizations** | **3 calendar months** | **Exclusively their own internal, isolated, non-production tests and evaluation** |
+
+The category is determined by the real Licensee and actual purpose, not by an individual's job title or a project's label. Research conducted by a commercial organization falls under its **three-month commercial evaluation period**. University teaching falls under the **24-month teaching period**; research conducted by that institution falls under the **six-month research period**, unless otherwise authorized. An employee or researcher cannot use the unlimited private permission to evade the restrictions applicable to an organization.
+
+### 3.1 Start and calculation
+
+A limited period begins on the date of **First Use** of the relevant Product by or on behalf of the Licensee and expires at the start of the corresponding calendar date after the applicable number of months (or at the start of the final calendar day if no corresponding date exists).
+
+A period runs once per Licensee and per Product. A different employee, device, installation, project name, software modification, download, or later version **does not reset or extend** that Licensee's period for the same Product. There is no registration, telephone-home function, or technical license-expiration requirement under this License; compliance with the dates remains the Licensee's responsibility.
+
+Extensions, cooperation arrangements, and other exceptions require **Written Permission** from the Licensor and may be free of charge or separately negotiated. No category grants Production Use, regardless of its duration.
+
+## 4. Experimental prototype — strict prohibition of Production Use
+
+**THE SOFTWARE IS AN EXPERIMENTAL RESEARCH AND DEVELOPMENT PROTOTYPE. IT IS NOT APPROVED, CERTIFIED, WARRANTED, OR REPRESENTED AS PRODUCTION-READY.**
+
+**PRODUCTION USE IS EXPRESSLY PROHIBITED UNDER THIS LICENSE IN ALL CIRCUMSTANCES, INCLUDING PRIVATE, EDUCATIONAL, ACADEMIC, SCIENTIFIC, INSTITUTIONAL, GOVERNMENTAL, AND COMMERCIAL SETTINGS.**
+
+**Production Use** includes, without limitation:
+
+1. Operating the Software in any live, operational, customer-facing, or production environment, even if the operator calls the deployment a trial, demonstration, pilot, or test.
+2. Using the Software to conduct, record, administer, or support actual financial transactions, business operations, services, or other real-world processes.
+3. Using the Software as the authoritative, primary, or operationally relied-upon store for financial, business, customer, personal, or other records needed in real-world activities.
+4. Connecting the Software to live services, workloads, or systems in a way that may affect their operation, availability, security, or data integrity.
+5. Relying on the Software's outputs, correctness, availability, or durability for operational decisions or for indispensable records.
+6. Incorporating the Software into a product, hosted service, or other system offered to or operated for third parties.
+
+**The prohibition applies even if the Software is free, even during an otherwise valid evaluation period, and even when a user voluntarily accepts the risks.**
+
+All permitted tests must be isolated in **non-production testing, research, teaching, or development environments**. Commercial Licensees may use the Software **only in their own internal non-production environments**; live-system evaluations and production pilots are not permitted. Test data must be used lawfully and safeguarded independently. The Software must never be the only or authoritative copy of data, and an experiment must not be able to impair operational systems or indispensable records.
+
+**Any Production Use without a separate express written license is outside the scope of this License and breaches its conditions.**
+
+## 5. Redistribution and derivative works
+
+Unless separately authorized by Written Permission or permitted by mandatory law, the Licensee must **not**:
+
+- Give, transmit, redistribute, publish, mirror, sell, rent, or sublicense copies of the original or modified Software to third parties.
+- Publish modified source code, independent public derivatives, modified packages, binaries, or releases.
+- Incorporate the Software into third-party products or provide its operation to third parties as a service.
+
+Internal copies within the same legal entity are permitted only insofar as necessary for licensed Non-Production Use. Required copyright and license notices must remain intact.
+
+Independent scientific results, descriptions, and benchmark findings may be published without permission **provided that the publication does not distribute the Software or substantial portions of protected source code** and does not falsely claim endorsement by the Licensor.
+
+## 6. GitHub forks
+
+When a Product is published in a public GitHub repository, GitHub users may view and fork it through GitHub's normal functionality to the extent provided by GitHub's applicable Terms of Service.
+
+**Forking an unmodified public repository through GitHub is permitted.** It does **not** grant any additional right to execute, deploy, distribute, sublicense, commercialize, or use the Software in production.
+
+**Publishing modified versions in public forks, distributing releases from forks, or otherwise publishing independent derivative software requires prior Written Permission** from the Licensor, except where an overriding right under the GitHub Terms of Service or mandatory law applies.
+
+This License does not purport to withdraw rights already granted by the Licensor under GitHub's applicable Terms of Service.
+
+## 7. Copyright and attribution
+
+**Copyright (c) 2026 Achim Meissner. All rights reserved.**
+
+All authorized copies and modifications must retain existing copyright notices, this License, and applicable third-party notices. The Licensee must not remove or falsify provenance or imply that the Licensor endorses an independent project.
+
+No ownership rights are transferred. All rights not expressly granted are reserved. No trademark, branding, or logo rights are granted beyond accurate identification of the Software. Third-party components continue to be governed by their own licenses.
+
+## 8. Use entirely at the Licensee's own risk
+
+**THE LICENSEE USES THE SOFTWARE ENTIRELY AT THE LICENSEE'S OWN RISK.**
+
+The Software is an **unfinished experimental development prototype**. It may contain defects, incorrect results, security vulnerabilities, incomplete features, platform limitations, crashes, data corruption, data loss, or unrecoverable files.
+
+The Licensee is solely responsible for using isolated test environments, selecting appropriate non-critical test data, maintaining independent backups, and preventing experiments from affecting operational systems. Passing tests, published benchmarks, source availability, and documentation **are not warranties and do not authorize Production Use**.
+
+## 9. No warranties or support obligation
+
+To the maximum extent permitted by applicable law, the Software is provided free of charge **"AS IS" and "AS AVAILABLE"**, without warranties or guarantees of any kind, including warranties of correctness, reliability, security, fitness for a particular purpose, availability, data integrity, durability, recoverability, or freedom from defects.
+
+The Licensor has no obligation to provide support, maintenance, compatibility updates, security patches, continuing availability of downloads, corrections, or data-recovery assistance unless separately agreed in writing.
+
+Mandatory rights or liabilities that cannot lawfully be excluded remain unaffected.
+
+## 10. Limitation of liability
+
+**TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW**, the Licensor excludes liability for loss or damage arising from the use, attempted use, inability to use, or unauthorized Production Use of the Software, including data loss, data corruption, financial loss, interruption of operations, lost profit, and consequential damage.
+
+For ordinary (slight) negligence, liability is excluded to the extent legally permissible. Where liability cannot be excluded because an essential contractual obligation has been breached, it is limited, insofar as legally permissible, to damage that was foreseeable and typical in view of this **free, experimental, strictly non-production** license.
+
+**Nothing in this License excludes or limits liability** for intentional misconduct, gross negligence where its exclusion is impermissible, injury to life, body, or health where liability cannot legally be excluded, fraudulent concealment, express guarantees assumed by the Licensor, or any other liability that mandatory law prevents the Licensor from excluding or limiting.
+
+Use outside the permitted scope, in particular prohibited Production Use, is not authorized by this License. This fact does not remove any mandatory statutory liability of the Licensor.
+
+## 11. Expiration and termination
+
+A time-limited license expires automatically at the end of its permitted period unless extended in writing. A material breach, including prohibited Production Use, unauthorized redistribution, or unauthorized public derivatives, terminates the relevant permission for the affected Product, subject to mandatory applicable law.
+
+Upon expiration or termination, the Licensee must **immediately cease executing, deploying, modifying, and otherwise using the affected Software**, unless a separate valid license applies.
+
+**Deletion of existing copies is not required.** Retention of a copy does not confer any further right of use. This License does not transfer ownership of the Licensee's independently owned data to the Licensor, but it also does not promise subsequent software access or data export or recovery services.
+
+The clauses on ownership, attribution, restrictions, warranty disclaimers, liability, and applicable law survive to the extent legally permissible.
+
+## 12. Separate commercial licenses and individual permissions
+
+**Any Production Use requires a separate, express written agreement** identifying the Product, authorized use, term, and any commercial, warranty, support, or liability conditions. No such rights are granted here.
+
+Requests for commercial licenses, academic cooperation, extensions, or permission to publish modified versions should be sent to:
+
+**achim.meissner@nhydb.de**  
+**https://nhy-db.com**
+
+## 13. Applicable law and mandatory rights
+
+This License is intended to be governed by the laws of the Federal Republic of Germany, subject to any overriding mandatory rules, including applicable consumer-protection provisions.
+
+Nothing here restricts rights that cannot be contractually excluded under applicable law, including mandatory statutory rights concerning computer programs.
+
+If a provision is invalid or unenforceable, the remaining provisions shall continue to apply to the extent legally permissible; mandatory statutory provisions govern the invalid part.
+
+---
+
+**End of NHyDB / dNHyDB Experimental Software License, Version 1.0.**

dnhydb-0.2.0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.4
+Name: dnhydb
+Version: 0.2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: Other/Proprietary License
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Database :: Database Engines/Servers
+Requires-Dist: tomli>=1.1 ; python_full_version < '3.11'
+Requires-Dist: numpy>=1.22 ; extra == 'numpy'
+Requires-Dist: pytest>=7 ; extra == 'test'
+Requires-Dist: numpy>=1.22 ; extra == 'test'
+Provides-Extra: numpy
+Provides-Extra: test
+License-File: LICENSE.md
+License-File: THIRD-PARTY-LICENSES.txt
+Summary: dNHyDB (directNHyDB) – general-purpose database with direct addressing (u, v, side); native Rust engine with Python bindings
+Keywords: database,storage-engine,rust,numpy,append-only
+Author-email: Achim Meissner <achim.meissner@nhydb.de>
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# dNHyDB (directNHyDB)
+
+**dNHyDB** is a general-purpose database with **direct structural
+addressing** `(R1, u, v, s)`: `u` is the record, `v` the field or position
+(both `u64`, 1 … 2^64−1), `s` the side (NL/NR). Ordinary records and fields
+work without tables or a primary index – the address space itself provides
+order. The NHyDB number `N = G² − u` (NL) or `G² + v` (NR) with `G = u + v` is
+computed arithmetically when needed and is never a storage key.
+
+The storage engine is written in native Rust; the Python package `dnhydb`
+binds it via PyO3 and offers single operations, NumPy batches and iterators.
+
+Version: **0.2.0** · Platforms: Linux, macOS, Windows · License: see
+[`LICENSE.md`](LICENSE.md)
+
+## Features
+
+* Native Rust core (`crates/dnhydb-core`) without Python dependency;
+  dependencies only `crc32fast`, `miniz_oxide`, `libc`.
+* Python package `dnhydb` (PyO3) with single-value API, NumPy batches and
+  iterators.
+* One writer (exclusive lock), any number of readers with snapshot isolation
+  at the commit boundary and `refresh()`.
+* Append-only container with two CRC-protected superblocks: after a crash the
+  last commit is valid, never half a batch.
+* Write buffer, commit policy (manual or thresholds, no background thread),
+  transactions with rollback, durability `fsync` / `full` / `none`.
+* Catalog side file for fast opening, iterators that skip gaps, configurable
+  caches, VALUE secondary index, compaction, repair, verify/health.
+
+## Installation
+
+From PyPI (prebuilt wheels for CPython 3.9–3.14 on Linux x86_64/aarch64,
+macOS x86_64/arm64 and Windows x64):
+
+```bash
+pip install dnhydb
+pip install numpy          # optional, for the NumPy batch API
+```
+
+The same files are attached to each release on the *Releases* page of the
+repository.
+
+From source (requires a Rust toolchain, see [`BUILDING.md`](BUILDING.md)):
+
+```bash
+pip install .
+```
+
+## Quick start (Python)
+
+```python
+import dnhydb
+
+with dnhydb.create("data.dnhydb") as db:
+    db.define_base([("date", "u64"), ("text", "utf8")])
+    with db.transaction():
+        db.put_record(1, [20261015, "Hello"])
+        db.put_cell(1, 1_000_001, "A poem …")
+
+reader = dnhydb.open_reader("data.dnhydb")
+print(reader.get_cell(1, 1_000_001))
+for v, value in reader.cells(1):
+    print(v, value)
+print(dnhydb.n_of(1, 1_000_001), dnhydb.address_of(dnhydb.n_of(1, 1_000_001)))
+```
+
+## Quick start (Rust)
+
+```rust
+use dnhydb_core::{Db, Options, Lane, TypeCode, Val, FieldSpec};
+
+let mut db = Db::create("data.dnhydb", Options::default())?;
+db.define_base(&[FieldSpec::new("date", TypeCode::U64), FieldSpec::new("text", TypeCode::Utf8)], None)?;
+db.put_record(1, &Val::List(vec![Val::from(20261015u64), Val::from("Hello")]), &[], Lane::NL)?;
+db.put_cell(1, 1_000_001, Val::from("A poem"), Lane::NL)?;
+db.commit()?;
+
+let r = Db::open_reader("data.dnhydb", Options::default())?;
+for c in r.cells(1, 1..=u64::MAX, Lane::NL) {
+    let (v, value) = c?;
+}
+```
+
+Command line: `dnhydb --help` (or `python -m dnhydb`).
+
+## Configuration
+
+All options are optional; see
+[`config/dnhydb_config.example.toml`](config/dnhydb_config.example.toml).
+
+## Known limitations
+
+* **Scope:** one realm (R1) and the CLASSIC layout only; `u` and `v` are
+  `u64`; integer values up to `i128`.
+* **One writer at a time** (exclusive lock on `<file>.lock`: `flock` on
+  Unix, `LockFileEx` on Windows); readers see the state of the last commit
+  and call `refresh()` for newer commits.
+* **Durability `full`:** on macOS `F_FULLFSYNC` is used; if the file system
+  rejects it, dNHyDB falls back to a plain `fsync` without reporting an
+  error. On Linux `full` is the same as `fsync`; on Windows both use
+  `FlushFileBuffers`. Directory entries are synced on Unix only (Windows:
+  NTFS journal).
+* **Platforms:** Linux (x86_64, aarch64), macOS (x86_64, arm64) and Windows (x64), CPython 3.9–3.14. On Windows, replacing the
+  database file while readers hold it open (compaction) uses POSIX rename
+  semantics (Windows 10 or newer, NTFS).
+
+## Documentation
+
+* [Technical documentation (English)](docs/en/dNHyDB_Technical_Documentation.md)
+* [Technische Dokumentation (Deutsch)](docs/de/dNHyDB_Technische_Dokumentation.md)
+* [`BUILDING.md`](BUILDING.md) – building wheels from source
+* [`RELEASING.md`](RELEASING.md) – versioning and release procedure
+* [`CHANGELOG.md`](CHANGELOG.md)
+
+## Tests and benchmarks
+
+```bash
+cargo test -p dnhydb-core --release     # Rust core
+pip install ".[test]"
+python -m pytest tests/python           # Python package (against the installed wheel)
+
+cargo run --release -p dnhydb-core --example bench -- 1000000 target/bench-tmp
+python benchmarks/bench_numpy.py
+```
+
+## Repository layout
+
+```text
+crates/dnhydb-core  native Rust core (format, codec, addresses, engine)
+crates/dnhydb-py    PyO3 binding (the only place with Python dependencies)
+python/dnhydb       Python package and CLI
+tests/python        Python tests
+benchmarks/         NumPy benchmark
+config/             example configuration
+docs/               documentation (de, en)
+.github/workflows/  CI: tests and wheels
+```
+
+## Scientific Background
+
+The mathematical foundations and database architecture are described in:
+
+Das Dynadron als mathematisches Datenbankprinzip
+
+https://doi.org/10.5281/zenodo.22549415
+
+https://doi.org/10.5281/zenodo.23438748
+
+https://doi.org/10.5281/zenodo.22694525
+
+## License
+
+dNHyDB is licensed under the **NHyDB / dNHyDB Experimental Software License 1.0**
+([`LICENSE.md`](LICENSE.md)). The source code is available, but this is
+**not an open-source license**: free use is limited to non-production
+purposes (unlimited for private individuals, time-limited for teaching,
+research and businesses), and **production use is not permitted** without a separate written license. Please read the
+license text before using the software.
+
+The compiled extension module contains third-party Rust components (all
+under MIT/Apache-2.0-style licenses); their notices are in
+[`THIRD-PARTY-LICENSES.txt`](THIRD-PARTY-LICENSES.txt), which is also shipped
+inside the wheel.
+
+## Contact
+
+Achim Meissner – achim.meissner@nhydb.de
+