-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
15f27ec
commit b154580
Showing
1 changed file
with
33 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,83 +1,70 @@ | ||
| # COMPAS Masonry | ||
|
|
||
| > [!WARNING] | ||
| > This plugin is under active development, | ||
| > and its functionality will frequently change. | ||
|  | ||
|
|
||
| COMPAS Masonry is a plugin for Rhino for the assessment of masonry structures. The current version of this plugin is based on COMPAS 2 and is available for Rhino 8. | ||
| COMPAS Masonry is a plugin for Rhino for the assessment of masonry structures, | ||
| and for the stability analsis of Discrete Element Models in general. | ||
|
|
||
| > [!WARNING] | ||
| > This plugin is under active development, | ||
| > and uses the still somewhat unstable CPython infrastructure | ||
| > of Rhino 8 through the new ScriptEditor. | ||
| > Therefore, unexpected errors may occur. | ||
| The current version of this plugin is based on COMPAS 2 and is available for Rhino 8. | ||
|
|
||
| ## Installation | ||
|
|
||
| To install COMPAS Masonry, use Rhino's package manager Yak. | ||
| To install COMPAS-Masonry, use Rhino's package manager Yak. | ||
| To open Yak, type `PackageManager` on the Rhino command line. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## COMPAS Packages | ||
|
|
||
| Masonry uses the following COMPAS packages: | ||
| COMPAS-Masonry uses the following COMPAS packages: | ||
|
|
||
| * [compas](https://github.com/compas-dev/compas) | ||
| * [compas_assembly](https://github.com/blockresearchgroup/compas_assembly) | ||
| * [compas_cra](https://github.com/blockresearchgroup/compas_cra) | ||
| * [compas_model](https://github.com/blockresearchgroup/compas_model) | ||
| * [compas_rui](https://github.com/blockresearchgroup/compas_rui) | ||
| * [compas_session](https://github.com/blockresearchgroup/compas_session) | ||
|
|
||
| After installing COMPAS Masonry with Yak, you can check if all requirements are installed using the command `Masonry_reqs_check`. | ||
|
|
||
| ### Basic Users | ||
|
|
||
| Missing requirements can be installed automatically using the command `Masonry_reqs_install`. | ||
| This command uses Rhino's built in installation mechanism for Python packages (`# r: ...`). | ||
|
|
||
| ### Advanced Users | ||
| After installing RhinoVAULT with Yak, these requirements will be installed automatically if necessary. | ||
| The tool might be unresponsive during this process, which might take up to 1 or 2 mins. | ||
| The packages are installed in a separate virtual environment named `COMPAS-Masonry`. | ||
|
|
||
| If you use Rhino for scripting, and if you have other COMPAS packages installed, or plan to install them in the future, we recommend to install Masonry's requirements manually using `pip`. | ||
|
|
||
| > [!WARNING] | ||
| > `pip` based installations and `# r: ...` based installations should not be mixed, | ||
| > since this will create conflicts between packages and package versions. | ||
| > [!NOTE] | ||
| > Note that COMPAS-Masonry currently doesn't include any solvers | ||
| > (such as [compas_cra](https://github.com/blockresearchgroup/compas_cra)) yet. | ||
| > This is because they have dependencies that are still difficult to install in Rhino. | ||
| ## User Interface | ||
|
|
||
| Masonry defines the following commands: | ||
| COMPAS-Masonry defines the following Rhino commands: | ||
|
|
||
| * `Masonry` | ||
| * `Masonry_pattern` | ||
| * `Masonry_pattern_modify` | ||
| * `Masonry_pattern_relax` | ||
| * `Masonry_pattern_supports` | ||
| * `Masonry_pattern_boundaries` | ||
| * `Masonry_form` | ||
| * `Masonry_force` | ||
| * `Masonry_tna_horizontal` | ||
| * `Masonry_tna_vertical` | ||
| * `Masonry_form_modify` | ||
| * `Masonry_force_modify` | ||
| * `Masonry_thrust_modify` | ||
| * `Masonry_scene_clear` | ||
| * `Masonry_scene_redraw` | ||
| * `Masonry_session_undo` | ||
| * `Masonry_session_redo` | ||
| * `Masonry_session_open` | ||
| * `Masonry_session_save` | ||
| * `Masonry_scene_clear` | ||
| * `Masonry_scene_redraw` | ||
| * `Masonry_settings` | ||
| * `Masonry_reqs_check` | ||
| * `Masonry_reqs_install` | ||
|
|
||
| These commands can be executed at the Rhino Command Prompt (simply start typing the command name), | ||
| or using the COMPAS Masonry toolbar. | ||
| These commands can be executed using the Rhino command line (simply start typing the command name), | ||
| or with the corresponding buttons of the COMPAS-Masonry toolbar. | ||
|
|
||
|  | ||
|
|
||
| If the toolbar is not visible after installing COMPAS-Masonry, | ||
| you can load it from the "Toolbars" page. | ||
| To open the "Toolbars" page, type `Toolbar` on the Rhino command line... | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## Documentation | ||
|
|
||
| For further "getting started" instructions, a tutorial, examples, and an detailed description of the individual commands and the user interface, please check out the online documentation here: [COMPAS Masonry Gitbook](https://blockresearchgroup.gitbook.io/compas-Masonry) | ||
| For further "getting started" instructions, a tutorial, examples, and an detailed description of the individual commands and the user interface, please check out the online documentation here: [COMPAS-Masonry Gitbook](https://blockresearchgroup.gitbook.io/COMPAS-Masonry) | ||
|
|
||
| ## Issue Tracker | ||
| ## Issues | ||
|
|
||
| If you find a bug or if you have a problem with running the code, please file an issue on the [Issue Tracker](https://github.com/blockresearchgroup/compas-Masonry/issues). | ||
| Please report problems using the issue tracker of the github repo: <https://github.com/blockresearchgroup/compas-Masonry/issues> |