Metadata-Version: 2.4
Name: energyplus-viewfactors
Version: 1.0.0
Summary: Calculate view factors for EnergyPlus
Project-URL: Documentation, https://github.com/building-physics/energyplus-viewfactors#readme
Project-URL: Issues, https://github.com/building-physics/energyplus-viewfactors/issues
Project-URL: Source, https://github.com/building-physics/energyplus-viewfactors
Author-email: "Jason W. DeGraw" <jason.degraw@gmail.com>
License-Expression: BSD-3-Clause
License-File: LICENSE.txt
Keywords: energyplus,epjson,view-factors,view3d
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Requires-Dist: click
Requires-Dist: pathvalidate
Requires-Dist: tkmacos; platform_system == 'Darwin'
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == 'dev'
Requires-Dist: mypy>=1.11; extra == 'dev'
Requires-Dist: pytest-cov>=5; extra == 'dev'
Requires-Dist: pytest>=8.3; extra == 'dev'
Requires-Dist: ruff>=0.9; extra == 'dev'
Description-Content-Type: text/markdown

# energyplus-viewfactors

[![PyPI - Version](https://img.shields.io/pypi/v/energyplus-viewfactors.svg)](https://pypi.org/project/energyplus-viewfactors)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/energyplus-viewfactors.svg)](https://pypi.org/project/energyplus-viewfactors)

-----

## Table of Contents

[Installation](#installation)
[Command-Line Usage](#command-line-usage)
[Development](#development)
[License](#license)

`energyplus-viewfactors` translates geometry from an EnergyPlus epJSON input file
into `.vs3` input files for the View3D program.

## Installation

Python 3.10 or newer is required.

```console
pip install energyplus-viewfactors
```

## Command-Line Usage

Create `.vs3` files for all zones:

```console
energyplus-viewfactors extract model.epJSON --output view3d
```

Create a file for one or more selected zones:

```console
energyplus-viewfactors extract model.epJSON --output view3d \
  --zone "Zone One" --zone "Zone Two"
```

The output directory must already exist.

## Development

Install the development tools:

```console
python -m pip install hatch
```

Hatch creates and manages the development environment from `pyproject.toml`.
Run the project checks through that environment:

```console
hatch run lint
hatch run types
hatch run test
hatch build
```

## License

`energyplus-viewfactors` is distributed under the terms of the [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html) license.
