Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Clone this wiki locally
When you are in a hackathon, or just interested in hacking with BIM tools, open source bim tools might be right for you. On this page we'll try to explain as much as possible about our tools.
Get an introduction/overview in this video: https://www.youtube.com/watch?v=S-XxpOm7bP0
If you can't find your answers, feel free to search the forum: http://support.opensourcebim.org/
There won't be many answers in a weekend, but maybe your question is already answered before...
We develop using Eclipse. Most of the tools work best in eclipse. Read the wiki page from BIMserver how to setup your workspace: https://github.com/opensourceBIM/BIMserver/wiki/Eclipse Read it till the end please... on the end of the page is also valuable information.
See the recorded presentations during the AEC Hackathon 1.1 (March 2014) here:
- Introduction to open source BIM tools: https://www.youtube.com/watch?v=S-XxpOm7bP0&hd=1 (Slides on slideshare)
- Federated BIM concept (also know as 'BIM Bots'): https://www.youtube.com/watch?v=09A2oy3sxOo&hd=1 (Slides on slideshare)
- BIMserver 'out of the box': https://www.youtube.com/watch?v=z6RwReXLFhU&hd=1
What you should know about BIMserver when you start hacking:
- find the API on http://yourbimserverlocation/admin/console.html.
- more info about the Interface(s) is available on https://github.com/opensourceBIM/BIMserver/wiki/Service-Interfaces
- A popular hack is to change the model on the server. We have 'low level calls' for that in the interface. Documented on https://github.com/opensourceBIM/BIMserver/wiki/Low-Level-Calls, and compliant with the Bimsie1LowLevelInterface part of BIMSie http://bimsie.openbimstandards.org
- It does not have a GUI (use bimvie.ws for that our build your own)
- It is based on plug-ins. Import/export (we call them 'deserializers' and 'serializers') merging, compare, etc. are all plugins. Put the .jar file from the plugin in the 'plugins' directory and restart. When you are in a hackathon you probably want to build an 'internal service' (even when you think you want to use a query plugin).
- Make sure you read the system requirements. You need 64bit java (double check that please!), if you want the advanced features install the JDK, free enough RAM memory and when you run tomcat one of the latest versions that support websockets: https://github.com/opensourceBIM/BIMserver/wiki/Requirements-1.4---2015-09-12
Official documentation on https://github.com/opensourceBIM/BIMserver/wiki
Tip: The easiest way to create something cool is to write an 'internal service' plugin in BIMserver. Internal services can be configured to be 'triggered' every time a new revision is checked into bimserver. They are just java code so very flexible. There are some examples under 'Tools' in our codebase. Related info about internal and remote services is available in our video about the 'Federated BIM' concept: https://www.youtube.com/watch?v=09A2oy3sxOo This concept is now called 'BIM Bots'.
- When you run bimserver and this tool on localhost, beware of the security issues when trying to connect.
Documentation is very poor in the readme on: https://github.com/opensourceBIM/BIMsurfer/blob/master/README.markdown
IfcOpenShell uses Open CASCADE (the Open CASCADE Community Edition) internally to convert the implicit geometry in IFC files into explicit geometry that any software CAD or modelling package can understand.
It is probably the best render engine out there at the moment.
You can use it stand alone, or as plugin in BIMserver to render triangles (that are stored in the BIMserver database). Have a look at the python stuff as well. This is very popular.
The sourcecode from IfcOpenShell is also on github: https://github.com/IfcOpenShell/IfcOpenShell
Find the .jar plugin for BIMserver on www.ifcopenshell.org. Put the jar file in the 'plugins' directory of your BIMserver system (you might want to restart BIMserver just to be sure).
BCF Forum is a wordpress plugin written in PHP. Find the source on https://github.com/opensourceBIM/BCF-Forum and the releases on https://github.com/opensourceBIM/BCF-Forum/releases
When you install wordpress you can use this plugin to turn your installation into a BCF server. Based on the BCF 2.0 standard.
BCF topics will be stored in the wordpress database. Under wp-admin you can configure the 'extensions.xsd' options. Viewing op topics and uploading zip files are supported, but complex operations are not yet implemented.
Find the documentation on https://github.com/opensourceBIM/BCF-Forum/wiki/BCF-Forum
GUI for BIMserver (actually for BIMSie compliant services).
Plugin for BIMserver to import/export from and to COBie. Very well documented on https://github.com/opensourceBIM/COBie-plugins/releases and the eBook http://www.lulu.com/shop/chris-bogen-and-e-william-east/cobie-plugin-for-bimserver-a-quick-start-guide/ebook/product-22300824.html
See https://github.com/opensourceBIM/ for all other projects. Some are experimental, some are deprecated. Feel free to swing them back alive again...