Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/pablo-mayrgundter/conway-old

Share data model
https://github.com/pablo-mayrgundter/conway-old

Last synced: 8 days ago
JSON representation

Share data model

Awesome Lists containing this project

README 

        

## Conway

 

Conway is the Bldrs.ai data-model and data transit system. Here we take existing standard formats, fit them against our own object model, allow ingress and egress, delta-changeset updates and transactions on the data, as well as appending components as a side-band that don't exist in the original data, allowing round-tripping of files, but also keeping features in our system they didn't originally support.



 It is written in TypeScript, but embeds (as a submodule) a fork of the [IFC-gen tool](https://github.com/bldrs-ai/IFC-gen) by hypar-io that is written in C#, utilising dotnet. This generates the IFC based model for Conway (which is currently a work in progress).



Conway itself is currently oriented around components, instead of a typical class hierarchy, to decouple different kinds of and make it easily queriable.  



### Building Conway



#### Deps

To run code-generation, you'll need to install version 6.0 of the .NET framework.



On a Ubuntu or Debian style distribution, you can install it like so:



    sudo apt-get update && \

    	  sudo apt-get install -y dotnet-sdk-6.0



On macOS, it should be installable with brew using:



	brew install dotnet@6



#### Build

 

Clone the repository, then in the root directory of the repository, run the yarn install, followed by using yarn to initialise the IFC-gen submodule:



	yarn install

	yarn submodule-update



        # set emsdk environment

	cd dependencies/conway-geom/dependencies/wasm/

	unzip dependencies.zip

 	cd -

	yarn build-conway_geom



After this, you can build using either an incremental build (which will not perform code-gen and will lead to the fastest build times), a watch build (which will automatically update changes), or a full rebuild, which will clean all build artefacts and perform code-gen, before running a build.



For the incremental build:



	yarn build-incremental



For the watch build:



	yarn build-watch



For a full, clean rebuild:



	yarn build-rebuild



You can also run the tests with jest:



	yarn test



And finally, using the watch functionality, you can also have the code automatically rebuild on change and also re-run the tests using:



	yarn build-test-watch



If you have Visual Studio Code, Conway also comes with a Visual Studio Code workspace to add IDE accessability to these features, and also let you edit the IFC-gen C# code in place.



## IFC Parser Console Test Application



Conway has a test application for parsing IFC step files to see the performance and included entity types at src/core/ifc/ifc_command_line_main.ts. 

Use an incremental or full build to compile this file from typescript and then it can be run with:



	node --experimental-specifier-resolution=node ./compiled/src/ifc/ifc_command_line_main.js [ifc file path]



	node --experimental-specifier-resolution=node ./compiled/src/ifc/ifc_command_line_main.js -g [ifc file path]



The included index.ifc in the repo is recommended for testing.



## Profiling WASM Builds in Node

Profiling Conway, including building a Conway-Geom WASM binary with DWARF information and generating a flame graph with WASM symbols, is possible via the following steps:

1. Run *build-profile-conway_geom* from Conway's package.json 

2. Profile your app: 

```

node --prof --experimental-specifier-resolution=node /Users/soar/Documents/GitHub/conway/compiled/src/ifc/ifc_command_line_main.js /Users/soar/Downloads/Schependomlaan.ifc -g

```

3. An isolate*.log file will be generated. Run:

```

node --prof-process --preprocess -j isolate*.log > v8.json # generate a V8 log

```

4. Go to https://mapbox.github.io/flamebearer/ and drop the log file to see a detailed flame graph.



## Problems with renaming in GIT merges



Because of the large number of files in conway that are code changes sometimes causing large modifications in merges, especially if generation locations are changed, it's sometimes necessary to up the limit of the number of renames in the git config for merging. It can be done like so:



	git config merge.renameLimit 99999



You may also wish to use a low rename threshold no-commit merge strategy for some of these situations to increase likelyhood that files will be related in the merge process and to track some of the more complicated changes:



	git merge -X rename-threshold=25 --no-commit