An open API service indexing awesome lists of open source software.

https://github.com/bhom/bhom_ui


https://github.com/bhom/bhom_ui

bhom core ui

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
[![Build status](https://ci.appveyor.com/api/projects/status/f4lrwf0x1uclsort/branch/master?svg=true)](https://ci.appveyor.com/api/projects/status/bhom_ui/branch/master)
[![Build Status](https://dev.azure.com/BHoMBot/BHoM/_apis/build/status/BHoM_UI/BHoM_UI.CheckCore?branchName=master)](https://dev.azure.com/BHoMBot/BHoM/_build/latest?definitionId=19&branchName=master)

# Core BHoM_UI Repo

This repo is part of the Buildings and Habitats object Model.
If you are new (_welcome!_ 👋 😄) a great place to start is on [bhom.xyz](https://bhom.xyz) and reading our [documentation](https://bhom.xyz/documentation), including our [Getting Started Pages](https://bhom.xyz/documentation/Basics/Using-the-BHoM/).

This particular repo contains the parent _BHoM UI_ defining all the base functionality necessary to expose the BHoM functionality through user interfaces.

The BHoM UI provides a central definition of the way the BHoM is exposed to the user. This includes the list of available components (icons, names,...), the way they are saved/loaded, as well as the various menus to create/interact with them. This guarantees that the learning curve of using the BHoM from one software to another is as minimal as possible. See [BH.UI ‐ Expose Your Code to UIs](https://github.com/BHoM/documentation/wiki/BH.UI-%E2%80%90-Expose-Your-Code-to-UIs) for more details.

Along with the rest of the core repositories - [BHoM](https://github.com/BHoM/BHoM), [BHoM_Engine](https://github.com/BHoM/BHoM_Engine) and [BHoM_Adapter](https://github.com/BHoM/BHoM_Adapter) – this is the basis on which all of the BHoM Toolkits are built.

## Quick Start 🚀

Grab the [latest installer](https://bhom.xyz/) and a selection of [sample scripts](https://github.com/BHoM/samples).

## Getting Started for Developers 🤖

If you want to build the BHoM and the Toolkits from source, it's hopefully easy! 😄
Do take a look at our specific wiki pages here: [Getting Started for Developers](https://bhom.xyz/documentation/Guides-and-Tutorials/Coding-with-BHoM/).

## Want to Contribute? ##

BHoM is an open-source project and would be nothing without its community. Take a look at our contributing guidelines and tips [here](https://github.com/BHoM/BHoM/blob/main/CONTRIBUTING.md).

## Licence ##

BHoM is free software licenced under GNU Lesser General Public Licence - [https://www.gnu.org/licenses/lgpl-3.0.html](https://www.gnu.org/licenses/lgpl-3.0.html)
Each contributor holds copyright over their respective contributions.
The project versioning (Git) records all such contribution source information.
See [LICENSE](https://github.com/BHoM/BHoM/blob/main/LICENSE) and [COPYRIGHT_HEADER](https://github.com/BHoM/BHoM/blob/main/COPYRIGHT_HEADER.txt).