Giter VIP home page Giter VIP logo

fire's Introduction

Fire

A prototype AI service stack for the 2024 YAL hackathon.

The stack comprises 5 services, namely:

  • fire-route: API server for generating Travel Routes in a room with obstacles.
  • fire-rvt: Revit 2024 plugin for interfacing with Fire APIs
  • fire-opt: Optimisation API server for generating extinguisher placements and evaluating whether a set of placements for a given room is acceptable or not.
  • fire-infer: API server for inference requests, and code for training base AI model.
  • fire-synth: Program for generating synthetic data for training AI model.

Usage

The application is split into 2 main parts:

  • Frontend: fire-rvt plugin for frontend interaction with BIM software
  • Backend: fire-opt and fire-route services for doing heavy computation.

Requirements

  • To build the plugin, Windows 10 or above is required.
  • To use this plugin, Autodesk Revit 2023 or later is required.
  • To run backend services, Python 3.8 and above is required.
  • The instructions below use bash commands, which may be harnessed through MinGW-w64 which is typically available on Windows by installing Git Bash.

Frontend

Building the Plugin

  1. Install the following development software:
    • Visual Studio 2017 Express or later
    • .NET Framework 4.8 SDK
    • NodeJS + pnpm (pnpm is recommended for faster package download)
  2. Build the web app. Make sure to change any IP addresses in the source files (will be changed later to read from .env files)
cd fire-rvt/ui/web-ui
pnpm i .
pnpm build
  1. Copy the web app over to the plugin's ui folder
rm -r ../../fire-rvt/ui
cp -r build/* ../../fire-rvt/ui
  1. Open fire-rvt/fire-rvt.sln.
  2. Run the Build command. This will build the binaries and automatically transfer them to your Revit 2023 plugin folder. Alternatively, built binaries may be found in fire-rvt/fire-rvt/bin

Backend

Setting up the Server

  1. Create a virtualenv, install Python dependencies, and activate it.
python -m venv venv
# on Linux:
source venv/bin/activate
# on Windows:
source venv/Scripts/activate
pip install -r requirements.txt
  1. Install pm2 through npm
npm i -g pm2
  1. Run start-server.sh
bash start-server.sh
  1. You may see the server log using:
pm2 log all
  1. You may also check the API docs at:

Contributors and Roles (Team ๐Ÿ”ฅ)

  • Atenn Neoh: Team Lead
  • Yvonne Zhang: Fire Engineering Subject Matter Expert
  • Bob YX Lee: Systems Integration, Full Stack Development
  • Tang Minjing: BIM Specialist
  • Evangelina Ong: BIM Specialist
  • Yuji Fujinami: UI/UX, Frontend Development, Machine Learning Implementation

fire's People

Contributors

boblyx avatar yuj8fuj6 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.