Update README.md
[wren/.git] / README.md
1 ### IMPORTANT: This is now an outdated, unsupported WikiHouse system. For the latest WikiHouse core system info please see the [Skylark repo](https://github.com/wikihouseproject/Skylark) and [WikiHouse guides](https://www.wikihouse.cc/guides)
2
3
4 # Wren
5
6 The language and rules for the Wren Wikihouse structural system, suitable for 1-3 storey buildings and initially developed in the UK for European contexts.
7
8 ![alt tag](https://github.com/wikihouseproject/Wren/blob/master/Images/Wren_overview.jpg)
9
10 ## Wren Hardware
11
12 Wren components are CNC manufuctured using structural-grade timber panel materials (typically, plywood) and can be rapidly assembled to produce a structural chassis, onto which other components such as cladding, windows, doors can be fitted.
13
14 #### Wren is in development. For full documentation on how Wren works and how you can contribute to its development, visit the [Wren wiki](https://github.com/wikihouseproject/Wren/wiki)
15
16 ## Wren Parametrics
17
18 This version of the Wren structural language has been developed in Grasshopper, the parametric scripting plugin for Rhino 3D. This computational design platform is widely used in the design and construction industries, and is ideally suited to digital manufacturing.
19
20 Other formats of the Wren system are currently being developed, but currently this version in Grasshopper format represents the latest thinking and workflow for the structural technology.
21
22 It should be taken as a Work in Progress and follows ‘a build something that works first’ approach. There are still several known areas where efficiency can be improved. There are also many ways the script can be extended to make use of Grasshopper’s expansive suite of tools include new features like structural analysis, nesting, GIS data, and solar/environmental tracking. We gladly welcome contributions from fellow computational designers to fork and develop!
23
24
25 ### Licence
26
27 The repository Grasshopper file WikiHouse_WREN_(v4.3) has been developed by Architecture 00.  
28
29 It is licensed under Mozilla Public Licence (MPL) version 2.0. For full legal terms of this licence visit: https://www.mozilla.org/en-US/MPL/2.0/
30
31 ### Plugins
32
33 This script makes use of the excellent developers toolbox of Grasshopper plugins, which makes this all possible. You will need to download and install the latest versions of these plugins from Food4Rhino.com before opening and running this script file.
34
35 The plugins used are:
36
37 - [Leafcutter](http://www.food4rhino.com/app/leafcutter-google-sheets-grasshopper) - for google sheets integration
38 - [Elefront](http://www.food4rhino.com/app/elefront) - for automated Grasshopper-to-Rhino flow
39 - [Human](http://www.food4rhino.com/app/human) - for automated Grasshopper-to-Rhino flow
40 - [Metahopper](http://www.grasshopper3d.com/group/metahopper) - for batch exports and script analysis
41
42 ### Known issues / limits
43
44 - **D-Joint splitting of the frame** - there is currently a very basic version of the logic but this probably needs to be custom scripted. The basic rules are no section should be larger than the sheet material (nominally 1220 x 2440mm) and D-joints are never closer than two grips to any corner/junction
45 - **Integration with Google Sheets** - While you can ‘drive’ the Wren script using the parameter sliders, the best way makes use of the Leafcutter plugin, which connects the script with a google spreadsheet for the input and output of project data. This is particularly handy when setting out the window and door sizes and locations.
46 - **Number of roof points** - Here be bugs, it may not work for multiple roof points and may also break the frame/sheathing geometry. Use with care.
47 - **Tolerance** - While tolerances can be added to slots in the 3D model, a much better/safer approach is to add tolerance offsets to the final nested cutting files, and keep the 3D geometry at 0mm tolerance.
48 - **Data Tree structures** - These can be streamlined much further within the Sheathing and Spacer component clusters to improve the file size/solution speed
49 - Custom scripts - custom C# / Python scripts can and should be added to replace large sections of the script to improve the flow and speed up processing
50 - **End-walls (in development)** - The gable end walls use the Wikihouse Weaver system (cassette-based) and still more development needed on an automated workflow here, specifically with how the front and rear facades are divided up around window openings. The parametric script for Weaver is not yet included in this initial release.
51 - **Notes/comments** -  There’s a definite lack of these in the clusters and subclusters. More detail and comments will be added soon, my apologies! If you have particularly questions get in touch via email or raise an issue here.
52
53 ## Wren Hardware R&D Contributions
54
55 **Architecture 00** (www.architecture00.net)
56 - [Alastair Parvin](https://twitter.com/AlastairParvin)
57 - [David Saxby](https://twitter.com/davidsx00)
58 - [Ryan McLoughlin](https://twitter.com/ryanjamesmac)
59 - [Clayton Prest](https://twitter.com/ClaytonPrest) 
60 - [Nick Ierodiaconou](https://twitter.com/nick_diaconou) 
61 - [Joni Steiner](https://twitter.com/jonisteiner)
62
63 **Momentum Engineering** (www.momentumengineering.com)
64 - Ben Whitfield
65 - Steve Fisher
66 - Rosie Stevenson
67
68 **Space Craft Systems** (www.spacecraft.co.nz)
69 - [Danny Squires](https://twitter.com/ecoarknz)
70 - [Martin Luff](https://twitter.com/martinluff)
71
72 **Arup Associates** (www.arup.com)
73 - Nina Tabink
74 - Adrian Campbell
75
76
77 **Individual Contributors**
78 - [Alex Whitcroft](https://twitter.com/AlexWhitcroft)
79 - Justyna Swat
80 - Nico Maes
81 - Akiko Kobayashi
82
83 **ULB Bruxelles**
84 - Structural engineering student group
85
86 ## Wren Parametric Contributions
87
88 **Architecture 00** (www.architecture00.net)
89 - [Clayton Prest](https://twitter.com/ClaytonPrest) 
90
91 **Architype - Team Architects** (http://www.architype-ta.co.nz/)
92 - [Agneesh Brahmbhatt](https://www.linkedin.com/in/agneesh-brahmbhatt-7557234?authType=NAME_SEARCH&authToken=MdJZ&locale=en_US&trk=tyah&trkInfo=clickedVertical%3Amynetwork%2CclickedEntityId%3A13733489%2CauthType%3ANAME_SEARCH%2Cidx%3A1-1-1%2CtarId%3A1482235340928%2Ctas%3Aag)
93
94 If you believe you are missing from either of these lists of historical contributions, please contact us or fork this document to amend.
95
96
97 # Terms of use
98
99 By downloading these files or information you agree to the following terms and conditions.
100
101 Information is shared without any kind of warranty or guarantee
102 All Information is provided ‘as is’. No representations or warranties express or implied are made regarding the Wikihouse Info, its accuracy, completeness, functionality or fitness for a particular use in a particular location.  
103
104 You are solely responsible for the use of the information
105 By using this information you assume full responsibility for any loss resulting from use or inability to use the Wikihouse Info, and forever releases WikiHouse Foundation or other WikiHouse users from any liability for such loss;  including but not limited to loss of profits, goodwill or assets.
106
107 You are responsible for meeting local codes and legislation
108 Users must satisfy themselves regarding the application of statutory requirements, local building regulations, codes, insurance certification or other requirements or recommendations relevant to the location where and materials with which they plan to build. Where required you should always seek the advice of a relevant qualified professional.
109
110 You are responsible for using the information in a safe way
111  Users are responsible for ensuring that information they use or cause to be used is used in a way which is safe, and is not likely to cause harm during or after manufacturing, construction, use or disassembly.