Giter VIP home page Giter VIP logo

ifc-api's Introduction

IFC-APIs

This image should enable you to easily start building IFC to LBD parsers.

This final image is on Dockerhub and can be installed from there.

Use

Install Docker Desktop

  • Run command docker-compose up from this folder
  • Visit http://localhost:5000/docs in your browser
  • Unfold POST /api/hello-ifc/ and click Try it out
  • Upload an IFC and execute the method

Run prebuilt image

If you just wish to use this image for your own implementation, simply get the built image from dockerhub and use the following docker-compose.yml:

version: '2.4'
services:

  ifc_apis:
    container_name: ifc_apis
    image: mhra/ifc-api:latest
    ports:
        - "5000:5000"
    networks:
        - "ifc_apis"
    volumes:
      - ./apis:/app/apis/

networks:
  ifc_apis:

All work is done in the apis folder, and you can start from the example in this repo and build from there. The important part is that you map your local folder to /app/apis in the container and that the folder contains a main.py file.

Extend

The apis folder contains all the code. main.py specifies endpoints that call methods in the methods-folder and the helpers-folder contains generic helper functions that can be used anywhere.

The included hello-ifc endpoint simply demonstrates the use of the API. How to load an IFC-file and how to build and return some simple JSON-LD representation of the content.

If you need Python packages that are not included already, add them to environment.yml and run docker-compose build

ifc-api's People

Contributors

madsholten avatar niras-mhra avatar

Watchers

James Cloos avatar  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.