https://github.com/pnnl/haskell-idf-executable

Executables for working with EnergyPlus Input Files (IDF)
https://github.com/pnnl/haskell-idf-executable

energyplus idf

Last synced: 27 days ago
JSON representation

Executables for working with EnergyPlus Input Files (IDF)

• Host: GitHub
• URL: https://github.com/pnnl/haskell-idf-executable
• Owner: pnnl
• License: other
• Created: 2018-03-01T01:28:13.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-01T01:29:10.000Z (almost 7 years ago)
• Last Synced: 2024-10-29T10:55:33.671Z (about 2 months ago)
• Topics: energyplus, idf
• Language: Haskell
• Homepage:
• Size: 7.81 KB
• Stars: 2
• Watchers: 7
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Haskell-IDF-Executable v0.1.0.0

`idf` is a suite of executables for working with EnergyPlus Input Files (IDF).

## Quick Start

* Install the [Haskell Tool Stack](https://haskellstack.org)

* `git clone https://github.com/pnnl/Haskell-IDF-Executable`

* `cd Haskell-IDF-Executable`

* `stack setup && stack build`

[Stackage](https://stackage.org) libraries are installed in `~/.stack`.

Project libraries and extra dependencies are installed in `Haskell-IDF-Executable/.stack-work` (see [here](https://docs.haskellstack.org/en/stable/faq/#where-is-stack-installed-and-will-it-interfere-with-ghc-etc-i-already-have-installed) for more information).

To uninstall `idf`, remove the `Haskell-IDF-Executable` directory, and then remove the `stack` command (see [here](https://docs.haskellstack.org/en/stable/faq/#how-do-i-reset-remove-stack-such-as-to-do-a-completely-fresh-build) for more information).

## Documentation

### `idf-graphviz(0)`

Convert the standard input to a labeled graph in the [DOT language](https://www.graphviz.org/doc/info/lang.html).

#### Synopsis

`idf-graphviz`

#### Description

`idf-graphviz` encodes and displays the labeled graph.

The standard input is decoded using a recursive descent parser for EnergyPlus Input Files (IDF).

Nodes in the graph correspond to classes in the EnergyPlus Data Dictionary (IDD).

Edges in the graph correspond to either hierarchical relationships between classes or references between instances of classes.

#### Options

*No options.*

#### Arguments

*No arguments.*

#### Examples

##### Convert standard input to labeled graph

* `stack exec idf-graphviz < in.idf > out.dot`

* Install [Graphviz](https://www.graphviz.org/)

* `dot -Tpng < out.dot > out.png`

### `idf-pprint(0)`

Pretty print the standard output.

#### Description

`idf-pprint` is a pretty printer.

The standard input is decoded using a recursive descent parser for EnergyPlus Input Files (IDF) and then, immediately,

re-encoded and displayed.

#### Synopsis

`idf-pprint`

#### Options

*No options.*

#### Arguments

*No arguments.*

#### Examples

##### Pretty print standard input

* `stack exec idf-pprint < in.idf > out.idf`

## License

BSD 3-clause "New" or "Revised" license (see the `LICENSE.txt` and `WARRANTY.txt` files in the distribution).

## Contributions

Contributions are accepted on [GitHub](https://github.com/) via the fork and pull request workflow.

See [here](https://help.github.com/articles/using-pull-requests/) for more information.