Metadata-Version: 2.4
Name: huira
Version: 0.9.1
Summary: A library for space rendering, LiDAR simulation, and solar radiation pressure modeling.
License-Expression: MIT
Project-URL: Homepage, https://huira.space
Project-URL: Documentation, https://docs.huira.space
Project-URL: Source, https://github.com/huira-render/huira
Project-URL: Issues, https://github.com/huira-render/huira/issues
Requires-Python: >=3.9
Description-Content-Type: text/markdown

![Huira](https://raw.githubusercontent.com/huira-render/huira/main/docs/_static/logo/full/blue_on_transparent.svg)

*Huira* is a library for space rendering, LiDAR simulation, and solar radiation pressure modeling.

[![Linux Build](https://github.com/huira-render/huira/actions/workflows/linux-ci-cd.yml/badge.svg?branch=main)](https://github.com/huira-render/huira/actions/workflows/linux-ci-cd.yml?query=branch%3Amain)
[![Windows Build](https://github.com/huira-render/huira/actions/workflows/windows-ci-cd.yml/badge.svg?branch=main)](https://github.com/huira-render/huira/actions/workflows/windows-ci-cd.yml?query=branch%3Amain)
[![macOS Build](https://github.com/huira-render/huira/actions/workflows/macos-ci-cd.yml/badge.svg?branch=main)](https://github.com/huira-render/huira/actions/workflows/macos-ci-cd.yml?query=branch%3Amain)

[![Conda Build](https://github.com/huira-render/huira/actions/workflows/conda-build.yml/badge.svg?branch=main)](https://github.com/huira-render/huira/actions/workflows/conda-build.yml?query=branch%3Amain)
[![vcpkg Build](https://github.com/huira-render/huira/actions/workflows/vcpkg-build.yml/badge.svg?branch=main)](https://github.com/huira-render/huira/actions/workflows/vcpkg-build.yml?query=branch%3Amain)
[![Python (PyPI)](https://github.com/huira-render/huira/actions/workflows/python.yml/badge.svg?branch=main)](https://github.com/huira-render/huira/actions/workflows/python.yml?query=branch%3Amain)

[![Coverage](https://codecov.io/gh/huira-render/huira/branch/main/graph/badge.svg)](https://app.codecov.io/gh/huira-render/huira/tree/main)

***

# Features
Initial work on Huira has been on the basic architecture as well as distribution/cross-platform compatability.  As much of that work is now completed, new features are expected to be released in relatively short order.

If there are features you wish to see, that you don't see listed here, please feel free to submit a [Feature Request](https://github.com/huira-render/huira/issues/new?template=feature_request.md)

## Currently Stable Features (as of v0.9.1)
- Radiometrically accurate rendering
- Calibrated camera distortion models and common camera controls
- Motion blur
- Depth-of-Field
- SPICE toolkit integration for spacecraft ephemeris and reference frames
- Star field and unresolved rendering
- Python Bindings
- Logging and crash report generation
- API Reference Documentation (NOTE: Some docs may appear incomplete or poorly formatted)

## Features Coming Soon (Order of Priority)
| Feature | Status | Expected by | Version |
| --- | --- | --- | --- |
| Digital Elevation Maps | In-Progress | 3/16/26 | v0.9.X |
| Level-of-Detail | Designed | 4/1/26 | v1.0.X |
| Additional BSDFs | In-Progress | 4/1/26 | v1.0.x |
| Solar Radiation Pressure | Designed | 4/1/26 | v1.0.X |
| LIDAR simulation | Planned | 5/1/26 | v1.0.X |
| TLE support | Licensing | - | - |

## Long Term Plans
- Vulkan based GPU Acceleration
- Desktop application (GUI)

## Known Bugs and Limitations
- Normal maps are not currently supported (see [issue](https://github.com/huira-render/huira/issues/32))
- PSF is not applied to extended objects, only point sources
- Severe lack of formal testing


***

# Examples
Example programs demonstrating common usage patterns are available in https://github.com/huira-render/huira/tree/main/examples

*** 

# Background
Huira is a complete rewrite providing similar functionality to the [vira](https://github.com/nasa/vira) project originally developed by the same author while at NASA's Goddard Space Flight Center. While inspired by vira, huira is built from scratch with new code and is released under the MIT license.

Vira is still maintained on a [personal fork by the original author](https://github.com/crgnam/vira).  However it is recommended to use this project moving forward.


***

# License
Huira is licensed under the [MIT License](https://github.com/huira-render/huira/blob/main/LICENSE)
