From 6f94530a9ecbef887239b72c23bffbc6bc390eaa Mon Sep 17 00:00:00 2001 From: tomvanmele Date: Fri, 4 Oct 2024 13:12:52 +0200 Subject: [PATCH] [GITBOOK] basic info --- gitbook/README.md | 26 ++++++++++++++++++++----- gitbook/SUMMARY.md | 4 +++- gitbook/additional/acknowledgements.md | 2 ++ gitbook/additional/contributions.md | 1 + gitbook/introduction/getting-started.md | 17 ++++++++++++++++ gitbook/introduction/tutorial.md | 11 +++++++++++ 6 files changed, 55 insertions(+), 6 deletions(-) create mode 100644 gitbook/additional/acknowledgements.md create mode 100644 gitbook/additional/contributions.md diff --git a/gitbook/README.md b/gitbook/README.md index acf4be3..5fda405 100644 --- a/gitbook/README.md +++ b/gitbook/README.md @@ -1,11 +1,27 @@ ---- -description: Practical Assessment Tools for Historic Masonry Structures ---- - -# COMPAS Masonry +# About {% hint style="warning" %} Note that this website is under construction and will be updated frequently! {% endhint %} +
+ COMPAS Masonry +
+

COMPAS Masonry is a plugin for Rhino 8 for the equilibrium analysis of discrete-element structures, +and for the stability assessment of (historic) masonry structures.

+
+
+ [![DOI](https://zenodo.org/badge/458133035.svg)](https://zenodo.org/badge/latestdoi/458133035) + +COMPAS Masonry is a plugin for Rhino 8 for the equilibrium analysis of discrete-element structures, +and for the stability assessment of (historic) masonry structures. + +The plugin is written entirely in Python using the [COMPAS framework](https://compas.dev), +and can be installed in Rhino 8 using Yak, the official package manager for Rhino. + +## Features + +## Limitations + +## Target Audience diff --git a/gitbook/SUMMARY.md b/gitbook/SUMMARY.md index 118fd52..a593f5f 100644 --- a/gitbook/SUMMARY.md +++ b/gitbook/SUMMARY.md @@ -13,8 +13,10 @@ ## Additional information -* [Legal terms](additional/legal.md) +* [Contributions](additional/contributions.md) +* [Acknowledgements](additional/acknowledgements.md) * [Citing COMPAS Masonry](additional/citing.md) +* [Legal terms](additional/legal.md) * [FAQ](additional/faq.md) ## Links diff --git a/gitbook/additional/acknowledgements.md b/gitbook/additional/acknowledgements.md new file mode 100644 index 0000000..df6756f --- /dev/null +++ b/gitbook/additional/acknowledgements.md @@ -0,0 +1,2 @@ +# Acknowledgements + diff --git a/gitbook/additional/contributions.md b/gitbook/additional/contributions.md new file mode 100644 index 0000000..eb337ed --- /dev/null +++ b/gitbook/additional/contributions.md @@ -0,0 +1 @@ +# Contributions diff --git a/gitbook/introduction/getting-started.md b/gitbook/introduction/getting-started.md index bad5562..f73c221 100644 --- a/gitbook/introduction/getting-started.md +++ b/gitbook/introduction/getting-started.md @@ -1 +1,18 @@ # Getting Started + +COMPAS Masonry is a plugin for Rhino 8 and uses the new CPython runtime. +It can be installed using Yak, Rhino's package manager. + +{% hint style="warning" %} +COMPAS Masonry is **only available for Rhino 8.** +{% endhint %} + +## Requirements + +## Installation + +## COMPAS Packages + +## Toolbar + +## Installation Check diff --git a/gitbook/introduction/tutorial.md b/gitbook/introduction/tutorial.md index 4f50ecc..ca4dcb5 100644 --- a/gitbook/introduction/tutorial.md +++ b/gitbook/introduction/tutorial.md @@ -1 +1,12 @@ # Tutorial + +In this tutorial, we will generate a very simple discrete element model representing a stone masonry arch. +We will then compute the required contact forces between the elements to establish equilibrium for given boundary conditions and gravity loads. + +## Generate an arch + +## Create a masonry model + +## Define boundary conditions + +## Compute equilibrium forces