# ibr

> JavaScript's functional programming helper library.

Latest version **0.1.0** (published 2020-07-20) · 0 weekly downloads

## Install

```sh
npm install ibr
pnpm add ibr
yarn add ibr
bun add ibr
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support; large bundle; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2020-07-20 |
| First published | 2020-07-20 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 56.6 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 461 |
| Author | Shuang Li |
| Maintainers | realkevinwang |

## Links

- npm: https://www.npmjs.com/package/ibr
- Repository: https://github.com/google/digitalbuildings
- Issues: https://github.com/google/digitalbuildings/issues
- npm.io page: https://npm.io/package/ibr

## Dependencies (2)

- [three](https://npm.io/package/three.md) ^0.118.3
- [ibr-sdk](https://npm.io/package/ibr-sdk.md) file:ibr-sdk

## Recent versions

- 0.1.0 (latest) — 2020-07-20

## README

# Internal Building Representation (IBR) File Format
IBR implements single file format that can be adapted to multiple use cases in any building.

Data in different verticals such as spatial, assets, and ontology often come from different source systems. This presents a challenge when a developer wants ensure updated data in downstream systems, especially when they want to combine data across multiple verticals. IBR is a solution that allows all of it to be combined in a meaningful, portable way.

IBR has no opinion of data requirements. If a developer wants to use IBR as an asset tracking tool, they can utilize the Objects message. If they later want to map asset locations to a single floor, that is possible by including a Layers message while updating the Objects messages with location data. If they want to track assets with relation to specific space classes, then they can add that data at a later stage without making a breaking change.

IBR comes with a rendering library built on THREE.js that can be used to easily create a custom UI to visualize and edit the compact data. This allows developers to build custom features and have more control over their tooling. 

## Instructions for Running the IBR UI:

1. Open terminal and run following commands:
    - `cd digitalbuildings/ibr`
    - `npm i`
    - `npm i ibr-sdk`
    - `mkdir -p temp/ && node_modules/.bin/pbf ibr.proto --browser > temp/ibr_pb_browser.js`

2. Open html/index.html in your browser.

On Mac, start chrome from terminal using this command instead:
    - `open -a "Google Chrome" html/index.html --args --allow-file-access-from-files`

3. Click on "Choose File" button to open your ibr data file

## Potential Issues and Fix

1. When using Chrome browser, see error "Blocked by CORS policy : Cross origin requests are only supported for protocol schemes: http, data, chrome, chrome-extension, https" in console

2. Start a local server in python
    - Open your command prompt (Windows)/ terminal (macOS/ Linux). To check Python is installed, enter the following command: `python -V`.
    - If python is installed, you should see a version number. If not, go to [python.org]() and install python3.
    - Once python3 is installed, run command `python3 -m http.server`.
    - Then navigate to http://0.0.0.0:8000/html/ in your browser.

3. Click on "Choose File" button to open your ibr data file

##### Developer Note: 

* The ibr-sdk npm package is not published, hence it cannot yet be installed in other projects.*
* Run `npx eslint \[filename\] --fix` to check efore Pull Request.*

---
_Source: https://npm.io/package/ibr · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._