pycauset 0.1.0__tar.gz

pycauset-0.1.0/.gitignore

@@ -0,0 +1,78 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# C++ / CMake
+CMakeCache.txt
+CMakeFiles/
+cmake_install.cmake
+Makefile
+*.vcxproj
+*.vcxproj.filters
+*.sln
+*.slnx
+*.dir/
+*.lib
+*.exp
+*.dll
+*.exe
+*.pdb
+*.ilk
+*.obj
+compile_commands.json
+CTestTestfile.cmake
+_deps/
+x64/
+Debug/
+Release/
+RelWithDebInfo/
+MinSizeRel/
+
+# VS Code
+.vscode/
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# PyCauset Specific
+.pycauset/
+*.pycauset
+*.pyd
+*.bin
+test_*.bin
+*_test.bin
+
+# Documentation
+.obsidian/workspace
+.obsidian/cache

pycauset-0.1.0/.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+    "files.associations": {
+        "*.tikz": "latex",
+        "bit": "cpp",
+        "filesystem": "cpp",
+        "random": "cpp",
+        "memory": "cpp"
+    }
+}

pycauset-0.1.0/CMakeLists.txt

@@ -0,0 +1,77 @@
+cmake_minimum_required(VERSION 3.15)
+project(pycauset VERSION 0.1.0 LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# --- Dependencies ---
+
+# 1. Python (Required for the extension)
+find_package(Python COMPONENTS Interpreter Development.Module REQUIRED)
+
+# 2. Pybind11 (Required)
+# If built via pip/scikit-build-core, pybind11 is provided.
+# If built manually, we might need to fetch it.
+find_package(pybind11 CONFIG)
+if(NOT pybind11_FOUND)
+    include(FetchContent)
+    FetchContent_Declare(
+      pybind11
+      URL https://github.com/pybind/pybind11/archive/refs/tags/v2.12.0.zip
+    )
+    FetchContent_MakeAvailable(pybind11)
+endif()
+
+# 3. OpenMP (Optional but recommended)
+find_package(OpenMP)
+
+# --- Source Files ---
+set(PYCAUSET_SOURCES
+    src/bindings.cpp
+    src/MemoryMapper.cpp
+    src/MatrixBase.cpp
+    src/TriangularMatrix.cpp
+    src/TriangularBitMatrix.cpp
+    src/MatrixOperations.cpp
+)
+
+# --- Extension Module ---
+# Note: The module name must match what is defined in PYBIND11_MODULE in bindings.cpp (which is "pycauset")
+python_add_library(pycauset MODULE ${PYCAUSET_SOURCES})
+
+# Include directories
+target_include_directories(pycauset PRIVATE include)
+
+# Link libraries
+target_link_libraries(pycauset PRIVATE pybind11::module)
+
+if(OpenMP_CXX_FOUND)
+    target_link_libraries(pycauset PRIVATE OpenMP::OpenMP_CXX)
+endif()
+
+# --- Installation ---
+# This installs the compiled extension into the python package directory
+install(TARGETS pycauset DESTINATION python/pycauset)
+
+# --- Testing (Only if explicitly requested or not a pip build) ---
+option(BUILD_TESTS "Build tests" OFF)
+if(BUILD_TESTS)
+    enable_testing()
+    include(FetchContent)
+    FetchContent_Declare(
+      googletest
+      URL https://github.com/google/googletest/archive/refs/tags/v1.14.0.zip
+    )
+    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    FetchContent_MakeAvailable(googletest)
+
+    add_executable(causal_tests tests/test_main.cpp ${PYCAUSET_SOURCES})
+    # Remove bindings.cpp from tests if it contains the main module definition which might conflict
+    # Actually bindings.cpp has PYBIND11_MODULE, which is fine in a library but maybe not in an executable if it has main?
+    # test_main.cpp has main(). bindings.cpp does not have main().
+    
+    target_include_directories(causal_tests PRIVATE include)
+    target_link_libraries(causal_tests PRIVATE GTest::gtest_main OpenMP::OpenMP_CXX)
+    
+    add_test(NAME CausalTests COMMAND causal_tests)
+endif()

pycauset-0.1.0/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.2
+Name: pycauset
+Version: 0.1.0
+Summary: High-performance Causal Set matrix operations using memory-mapped files
+Author-Email: BrorH <your.email@example.com>
+License: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: C++
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Project-URL: Homepage, https://github.com/BrorH/pycauset
+Project-URL: Repository, https://github.com/BrorH/pycauset
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# PyCauset
+
+**PyCauset** is a high-performance Python module designed for numerical work with [Causal Sets](https://en.wikipedia.org/wiki/Causal_sets). It is built to handle massive matrices (up to $N=10^6$) that exceed available RAM by leveraging memory-mapped files and efficient C++ backends.
+
+## Why PyCauset?
+
+For a causal set of size $N$, the relevant mathematical objects are typically of order $\mathcal O(N^2)$ and operations are $\mathcal O(N^3)$. For even moderate sizes like $N=10,000$, standard in-memory libraries like NumPy can struggle with memory limits.
+
+**PyCauset solves this by:**
+*   **Memory Mapping**: Storing matrices on disk and loading only necessary chunks into RAM.
+*   **Bit Packing**: Storing boolean matrices (causal relations) as individual bits, reducing storage requirements by 8x-64x compared to standard types.
+*   **C++ Efficiency**: Core operations are implemented in optimized C++.
+
+## Installation
+
+### Prerequisites
+PyCauset requires a C++ compiler to build the native extension.
+*   **Windows**: Install **Visual Studio Build Tools** with the "Desktop development with C++" workload.
+*   **Linux/macOS**: Install `gcc` or `clang`.
+
+### Build & Install
+Clone the repository and run the build script:
+
+```powershell
+# Build the C++ extension and Python module
+./build.ps1 -Python
+
+# To run tests as well
+./build.ps1 -All
+```
+
+## Quick Start
+
+### 1. Creating Matrices
+The primary structure for causal sets is the `TriangularBitMatrix` (aliased as `CausalMatrix`).
+
+```python
+import pycauset
+
+# Create a random 1000x1000 causal matrix (Bernoulli p=0.5)
+C = pycauset.CausalMatrix.random(1000, density=0.5)
+
+# Create an empty matrix (initialized to zeros)
+C_empty = pycauset.CausalMatrix(1000)
+
+# Create from a NumPy array
+import numpy as np
+arr = np.triu(np.random.randint(0, 2, (10, 10)), k=1).astype(bool)
+C_from_np = pycauset.CausalMatrix(arr)
+```
+
+### 2. Matrix Operations
+PyCauset supports standard arithmetic and specialized causal set operations.
+
+```python
+# Matrix Multiplication (Counting paths of length 2)
+# Returns an IntegerMatrix
+M = pycauset.matmul(C, C)
+
+# Elementwise Multiplication
+E = C * C
+
+# Bitwise Inversion (NOT)
+C_inv = ~C
+
+# Linear Algebra Inversion (for dense float matrices)
+# Returns a FloatMatrix
+F = pycauset.FloatMatrix(100)
+F_inv = pycauset.invert(F)
+```
+
+### 3. Computing the K-Matrix
+A common operation in causal set theory is computing $K = C(aI + C)^{-1}$.
+
+```python
+# Compute K with scalar a=1.0
+# Returns a TriangularFloatMatrix
+K = pycauset.compute_k(C, a=1.0)
+```
+
+## Matrix Types
+
+PyCauset uses a template-based architecture to support efficient storage for different data types:
+
+| Class | Description | Storage |
+|-------|-------------|---------|
+| `TriangularBitMatrix` | Strictly upper-triangular boolean matrix. | 1 bit / element |
+| `IntegerMatrix` | Dense matrix of 32-bit integers. | 4 bytes / element |
+| `FloatMatrix` | Dense matrix of 64-bit floats. | 8 bytes / element |
+| `TriangularFloatMatrix` | Strictly upper-triangular float matrix. | 8 bytes / element |
+
+## Storage Management
+
+PyCauset manages disk storage automatically to keep your workspace clean.
+
+*   **Temporary Files**: All matrices are created as temporary files in a `.pycauset/` directory. These files are **automatically deleted** when your Python script exits (even if it crashes or is interrupted).
+*   **Permanent Storage**: To keep a matrix, you **must** use the `save()` function.
+
+```python
+# This matrix is temporary and will be deleted at exit
+temp = pycauset.CausalMatrix(500)
+
+# Save it permanently to a specific path
+pycauset.save(temp, "my_causet.pycauset")
+```

pycauset-0.1.0/README.md

@@ -0,0 +1,105 @@
+# PyCauset
+
+**PyCauset** is a high-performance Python module designed for numerical work with [Causal Sets](https://en.wikipedia.org/wiki/Causal_sets). It is built to handle massive matrices (up to $N=10^6$) that exceed available RAM by leveraging memory-mapped files and efficient C++ backends.
+
+## Why PyCauset?
+
+For a causal set of size $N$, the relevant mathematical objects are typically of order $\mathcal O(N^2)$ and operations are $\mathcal O(N^3)$. For even moderate sizes like $N=10,000$, standard in-memory libraries like NumPy can struggle with memory limits.
+
+**PyCauset solves this by:**
+*   **Memory Mapping**: Storing matrices on disk and loading only necessary chunks into RAM.
+*   **Bit Packing**: Storing boolean matrices (causal relations) as individual bits, reducing storage requirements by 8x-64x compared to standard types.
+*   **C++ Efficiency**: Core operations are implemented in optimized C++.
+
+## Installation
+
+### Prerequisites
+PyCauset requires a C++ compiler to build the native extension.
+*   **Windows**: Install **Visual Studio Build Tools** with the "Desktop development with C++" workload.
+*   **Linux/macOS**: Install `gcc` or `clang`.
+
+### Build & Install
+Clone the repository and run the build script:
+
+```powershell
+# Build the C++ extension and Python module
+./build.ps1 -Python
+
+# To run tests as well
+./build.ps1 -All
+```
+
+## Quick Start
+
+### 1. Creating Matrices
+The primary structure for causal sets is the `TriangularBitMatrix` (aliased as `CausalMatrix`).
+
+```python
+import pycauset
+
+# Create a random 1000x1000 causal matrix (Bernoulli p=0.5)
+C = pycauset.CausalMatrix.random(1000, density=0.5)
+
+# Create an empty matrix (initialized to zeros)
+C_empty = pycauset.CausalMatrix(1000)
+
+# Create from a NumPy array
+import numpy as np
+arr = np.triu(np.random.randint(0, 2, (10, 10)), k=1).astype(bool)
+C_from_np = pycauset.CausalMatrix(arr)
+```
+
+### 2. Matrix Operations
+PyCauset supports standard arithmetic and specialized causal set operations.
+
+```python
+# Matrix Multiplication (Counting paths of length 2)
+# Returns an IntegerMatrix
+M = pycauset.matmul(C, C)
+
+# Elementwise Multiplication
+E = C * C
+
+# Bitwise Inversion (NOT)
+C_inv = ~C
+
+# Linear Algebra Inversion (for dense float matrices)
+# Returns a FloatMatrix
+F = pycauset.FloatMatrix(100)
+F_inv = pycauset.invert(F)
+```
+
+### 3. Computing the K-Matrix
+A common operation in causal set theory is computing $K = C(aI + C)^{-1}$.
+
+```python
+# Compute K with scalar a=1.0
+# Returns a TriangularFloatMatrix
+K = pycauset.compute_k(C, a=1.0)
+```
+
+## Matrix Types
+
+PyCauset uses a template-based architecture to support efficient storage for different data types:
+
+| Class | Description | Storage |
+|-------|-------------|---------|
+| `TriangularBitMatrix` | Strictly upper-triangular boolean matrix. | 1 bit / element |
+| `IntegerMatrix` | Dense matrix of 32-bit integers. | 4 bytes / element |
+| `FloatMatrix` | Dense matrix of 64-bit floats. | 8 bytes / element |
+| `TriangularFloatMatrix` | Strictly upper-triangular float matrix. | 8 bytes / element |
+
+## Storage Management
+
+PyCauset manages disk storage automatically to keep your workspace clean.
+
+*   **Temporary Files**: All matrices are created as temporary files in a `.pycauset/` directory. These files are **automatically deleted** when your Python script exits (even if it crashes or is interrupted).
+*   **Permanent Storage**: To keep a matrix, you **must** use the `save()` function.
+
+```python
+# This matrix is temporary and will be deleted at exit
+temp = pycauset.CausalMatrix(500)
+
+# Save it permanently to a specific path
+pycauset.save(temp, "my_causet.pycauset")
+```

pycauset-0.1.0/SETUP_INSTRUCTIONS.md

@@ -0,0 +1,32 @@
+# Setup Instructions
+
+## 1. Install a C++ Compiler
+Your system is missing a C++ compiler. Since you are on Windows, the recommended way is to install **Visual Studio Build Tools**.
+
+1.  Download **Visual Studio Community 2022** (Free) from: [https://visualstudio.microsoft.com/vs/community/](https://visualstudio.microsoft.com/vs/community/)
+2.  Run the installer.
+3.  **Crucial Step**: In the "Workloads" tab, check the box for **"Desktop development with C++"**.
+    *   This ensures the MSVC compiler (`cl.exe`) and Windows SDK are installed.
+4.  Click **Install**.
+
+## 2. Verify Installation
+After installation completes:
+1.  **Restart Visual Studio Code** (completely close and reopen it) to refresh environment variables.
+2.  Open a terminal and try running:
+    ```powershell
+    cl
+    ```
+    *Note: `cl` might not be in your global PATH, which is fine. CMake usually finds it automatically.*
+
+## 3. Build & Test
+Use the consolidated build script:
+```powershell
+# Build everything and run C++ tests + Python module
+.\build.ps1 -All
+
+# Only run C++ tests
+.\build.ps1 -Tests
+
+# Only build the Python module
+.\build.ps1 -Python
+```

pycauset-0.1.0/build.ps1

@@ -0,0 +1,157 @@
+param(
+    [switch]$Tests,
+    [switch]$Python,
+    [switch]$All,
+    [string]$PythonVersion,
+    [string]$PythonExe
+)
+
+if (-not ($Tests -or $Python -or $All)) {
+    $All = $true
+}
+
+if ($All) {
+    $Tests = $true
+    $Python = $true
+}
+
+$resolvedPythonExe = $null
+if ($PythonExe) {
+    if (Test-Path $PythonExe) {
+        $resolvedPythonExe = (Resolve-Path $PythonExe).Path
+    } else {
+        Write-Host "Provided PythonExe path '$PythonExe' was not found." -ForegroundColor Red
+        exit 1
+    }
+} elseif ($PythonVersion) {
+    Write-Host "Resolving Python $PythonVersion using py launcher..." -ForegroundColor Cyan
+    try {
+        $pyArgs = @("-$PythonVersion", "-c", "import sys; print(sys.executable)")
+        $resolvedPythonExe = (& py @pyArgs).Trim()
+        if (-not $resolvedPythonExe) {
+            throw "py launcher did not return a path."
+        }
+    } catch {
+        Write-Host "Unable to resolve Python version $PythonVersion via py launcher: $_" -ForegroundColor Red
+        exit 1
+    }
+
+    if (-not (Test-Path $resolvedPythonExe)) {
+        Write-Host "Resolved Python path '$resolvedPythonExe' does not exist." -ForegroundColor Red
+        exit 1
+    }
+}
+
+if ($resolvedPythonExe) {
+    Write-Host "Using Python executable: $resolvedPythonExe" -ForegroundColor Yellow
+}
+
+Write-Host "Checking for CMake..."
+if (-not (Get-Command cmake -ErrorAction SilentlyContinue)) {
+    $commonPaths = @(
+        "C:\Program Files\CMake\bin",
+        "C:\Program Files (x86)\CMake\bin"
+    )
+    foreach ($path in $commonPaths) {
+        if (Test-Path "$path\cmake.exe") {
+            Write-Host "Found CMake at $path. Adding to session PATH." -ForegroundColor Yellow
+            $env:Path = "$path;$env:Path"
+            break
+        }
+    }
+}
+
+if (-not (Get-Command cmake -ErrorAction SilentlyContinue)) {
+    Write-Host "Error: CMake is not in your PATH." -ForegroundColor Red
+    exit 1
+}
+
+$buildDir = "build"
+if (-not (Test-Path $buildDir)) {
+    Write-Host "Creating build directory..."
+    New-Item -ItemType Directory -Path $buildDir | Out-Null
+}
+
+Push-Location $buildDir
+
+$cmakeConfigureArgs = @("..")
+if ($resolvedPythonExe) {
+    $normalizedExe = $resolvedPythonExe -replace "\\", "/"
+    $cmakeConfigureArgs = @("-DPython3_EXECUTABLE:FILEPATH=$normalizedExe", "-DPython_EXECUTABLE:FILEPATH=$normalizedExe") + $cmakeConfigureArgs
+}
+
+Write-Host "Configuring project..." -ForegroundColor Cyan
+cmake @cmakeConfigureArgs
+if ($LASTEXITCODE -ne 0) {
+    Write-Host "Configuration failed." -ForegroundColor Red
+    Pop-Location
+    exit 1
+}
+
+if ($Tests) {
+    Write-Host "Building tests..." -ForegroundColor Cyan
+    cmake --build . --config Release --target causal_tests
+    if ($LASTEXITCODE -ne 0) {
+        Write-Host "Test build failed." -ForegroundColor Red
+        Pop-Location
+        exit 1
+    }
+
+    Write-Host "Running tests..." -ForegroundColor Cyan
+    $possiblePaths = @(
+        ".\Release\causal_tests.exe",
+        ".\tests\Release\causal_tests.exe",
+        ".\causal_tests.exe",
+        ".\tests\causal_tests.exe"
+    )
+
+    $testExe = $null
+    foreach ($path in $possiblePaths) {
+        if (Test-Path $path) {
+            $testExe = $path
+            break
+        }
+    }
+
+    if ($testExe) {
+        Write-Host "Found executable at: $testExe" -ForegroundColor Gray
+        & $testExe
+        if ($LASTEXITCODE -ne 0) {
+            Write-Host "Tests failed." -ForegroundColor Red
+            Pop-Location
+            exit 1
+        }
+    } else {
+        Write-Host "Could not find test executable." -ForegroundColor Red
+        Pop-Location
+        exit 1
+    }
+}
+
+if ($Python) {
+    Write-Host "Building pycauset module..." -ForegroundColor Cyan
+    cmake --build . --config Release --target pycauset
+    if ($LASTEXITCODE -ne 0) {
+        Write-Host "Python module build failed." -ForegroundColor Red
+        Pop-Location
+        exit 1
+    }
+
+    $pydFile = Get-ChildItem -Recurse -Filter "pycauset*.pyd" | Select-Object -First 1
+    if ($pydFile) {
+        $packageDir = Join-Path .. "python/pycauset"
+        if (-not (Test-Path $packageDir)) {
+            New-Item -ItemType Directory -Path $packageDir | Out-Null
+        }
+        Copy-Item $pydFile.FullName -Destination $packageDir -Force
+        Copy-Item $pydFile.FullName -Destination ..\ -Force
+        Write-Host "Copied module to python/pycauset and project root" -ForegroundColor Green
+    } else {
+        Write-Host "Could not locate generated pycauset module." -ForegroundColor Red
+        Pop-Location
+        exit 1
+    }
+}
+
+Pop-Location
+Write-Host "Build complete." -ForegroundColor Green

pycauset-0.1.0/build_python.ps1

@@ -0,0 +1,31 @@
+# Build Python Module
+Write-Host "Building Python Module..." -ForegroundColor Cyan
+
+# Create build directory
+if (-not (Test-Path "build")) { New-Item -ItemType Directory -Path "build" | Out-Null }
+Push-Location build
+
+# Configure & Build
+cmake ..
+if ($LASTEXITCODE -ne 0) { Write-Host "Configuration failed." -ForegroundColor Red; Pop-Location; exit 1 }
+
+cmake --build . --config Release --target pycauset
+if ($LASTEXITCODE -ne 0) { Write-Host "Build failed." -ForegroundColor Red; Pop-Location; exit 1 }
+
+# Find the generated .pyd file
+$pydFile = Get-ChildItem -Recurse -Filter "pycauset*.pyd" | Select-Object -First 1
+
+if ($pydFile) {
+    Write-Host "Found module: $($pydFile.FullName)" -ForegroundColor Green
+    $packageDir = Join-Path .. "python/pycauset"
+    if (-not (Test-Path $packageDir)) {
+        New-Item -ItemType Directory -Path $packageDir | Out-Null
+    }
+    Copy-Item $pydFile.FullName -Destination $packageDir -Force
+    Copy-Item $pydFile.FullName -Destination ..\ -Force
+    Write-Host "Copied to python/pycauset/ and project root."
+} else {
+    Write-Host "Could not find generated .pyd file." -ForegroundColor Red
+}
+
+Pop-Location