https://github.com/hexedpackets/fault_tree
Fault Tree Analysis built in Elixir
https://github.com/hexedpackets/fault_tree
Last synced: 12 months ago
JSON representation
Fault Tree Analysis built in Elixir
- Host: GitHub
- URL: https://github.com/hexedpackets/fault_tree
- Owner: hexedpackets
- License: apache-2.0
- Created: 2019-05-15T19:52:33.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-06T13:34:46.000Z (about 7 years ago)
- Last Synced: 2025-06-30T06:47:22.483Z (12 months ago)
- Language: Elixir
- Size: 54.7 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FaultTree
FaultTree is a library for performing [fault tree analysis](https://en.wikipedia.org/wiki/Fault_tree_analysis). It includes a small HTTP server capable of graphing the resulting FTA, or returning it as JSON.
## Installation
The FaultTree package can be installed from Hex
by adding `fault_tree` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:fault_tree, "~> 0.2.0"}
]
end
```
Documentation can be found at [https://hexdocs.pm/fault_tree](https://hexdocs.pm/fault_tree).
## Running
Run the server with `mix trot.server`, or `iex -S mix` for an interactive shell. The analysis can be run by uploading XML at http://localhost:4000/.
## Input format
The expected input is an XML document matching the [SCRAM/openpsa format](https://github.com/rakhimov/scram/blob/master/share/input.rng). Alternatively, the fault tree can be created using Elixir code. Example:
```elixir
FaultTree.create(:or)
|> FaultTree.add_basic("root", "0.01", "foo")
|> FaultTree.add_basic("root", "0.01", "bar")
|> FaultTree.build()
```
Will build the following tree:
```elixir
%FaultTree.Node{
atleast: nil,
children: [
%FaultTree.Node{
atleast: nil,
children: [],
description: nil,
id: 2,
name: "bar",
parent: "root",
probability: #Decimal<0.01>,
source: nil,
type: :basic
},
%FaultTree.Node{
atleast: nil,
children: [],
description: nil,
id: 1,
name: "foo",
parent: "root",
probability: #Decimal<0.01>,
source: nil,
type: :basic
}
],
description: nil,
id: 0,
name: "root",
parent: nil,
probability: #Decimal<0.0199>,
source: nil,
type: :or
}
```