Metadata-Version: 2.4
Name: pyaccelerad
Version: 0.1.1
Summary: Python interface for Accelerad, mimicking Pyradiance.
Author: Kevin Huberty
License: MIT License
        
        Copyright (c) 2025 Kevin Huberty
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/nljones/Accelerad
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyradiance
Dynamic: license-file

# Pyaccelerad

Pyaccelerad is a Python interface for [Accelerad](https://nljones.github.io/Accelerad/), designed to mimic the API of [Pyradiance](https://github.com/LBNL-ETA/pyradiance).

It wraps the Accelerad binaries (`accelerad_rpict`, `accelerad_rtrace`, etc.) allowing you to call them from Python.

## Installation

```bash
pip install .
```

## Requirements

**Accelerad Binaries**: You must have Accelerad installed.
By default, Pyaccelerad looks for binaries in:
`C:\Program Files\Accelerad\bin`

You can override this by setting the `ACCELERAD_BIN` environment variable to your Accelerad bin directory.

## Usage

```python
import pyaccelerad as pa

# Call accelerad_rpict
# Arguments are passed as flags.
# e.g. -ab 5 becomes ab=5
# Positional arguments are passed as a list.

# Example: accelerad_rpict -ab 5 -vf view.vf scene.oct
output_image_data = pa.rpict("scene.oct", ab=5, vf="view.vf")

# You can write the output to a file
with open("output.hdr", "wb") as f:
    f.write(output_image_data)
```

## Mapped Functions

The following functions are mapped to their Accelerad counterparts:

- `rpict` -> `accelerad_rpict`
- `rtrace` -> `accelerad_rtrace`
- `rcontrib` -> `accelerad_rcontrib`
- `rfluxmtx` -> `accelerad_rfluxmtx`
- `genBSDF` -> `accelerad_genBSDF`

## Notes on Binaries

Accelerad binaries are compiled against specific CUDA versions. Ensure your installed Accelerad version matches your hardware and drivers. Pyaccelerad does not bundle these binaries; it relies on your local installation.
