1
1
# AdSec-Grasshopper
2
+
2
3
 [](https://www.food4rhino.com/en/app/adsec)
3
4
4
- AdSec-Grasshopper is a plugin for Grasshopper wrapping Oasys AdSec's .NET API. The plugin allows users of Grasshopper to create, edit and analyse AdSec models seemlesly.
5
+ AdSec-Grasshopper is a plugin for Grasshopper wrapping Oasys AdSec's .NET API. The plugin allows users of Grasshopper to create, edit and analyse AdSec models seemlesly.
5
6
6
7
| Latest | CI Pipeline | Unit Tests | Deployment | Dependencies |
7
8
| ------ | ----------- | ---------- | ---------- | ------------ |
8
9
| [](https://github.com/arup-group/AdSec-Grasshopper/releases) <br />  <br />  |  <br />  | [](https://codecov.io/gh/arup-group/AdSec-Grasshopper) <br />  |  <br />  |  <br />  |
9
10
10
11
## Documentation
12
+
11
13
[ ![ Docs] ( https://img.shields.io/badge/Docs-AdSec%20API-125DA9?logo=readme&logoColor=white&style=flat-square )] ( https://arup-group.github.io/oasys-combined/adsec-api/ )
12
14
13
15
AdSecGH documentation tbd
14
16
15
17
## Example Files
18
+
16
19
[](/ExampleFiles)
17
20
18
21
This repository contains a number of example files that are also used for testing on new releases, please check out the [ ExampleFiles folder] ( /ExampleFiles ) for a growing list of Grasshopper files.
19
22
20
23
## Contributing
21
- ![ GitHub pull requests] ( https://img.shields.io/github/issues-pr-raw/arup-group/adsec-grasshopper?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAADNSURBVHgB7VXbDcMgDHSjDpCRMgojZIOwQdMJ6CYZiRFco7qSi3gYSqV+5KSTcOTzEZAOgH8EIm7QgyAkeuat0IPQijAQX3DEB69tanivQdi1E3Uw8anhEQ6iyc2dSp5Rfcn0LURXvZdwHOKIHK/3TA9yPRNX8TdLzWQXzTbTs8Z3IIwPqEHusNBjonpmmYcRBi26CX6M0+A0GGwg8wQzcZ2CSoeKuP5Kh5W4LhgUdS1xrcWH7irWd+Im4sTwtxr0Oo7r95tsQYle3RA8AW71bDMxGCXJAAAAAElFTkSuQmCC )
24
+
25
+ ![ GitHub pull requests] ( https://img.shields.io/github/issues-pr-raw/arup-group/adsec-grasshopper?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAADNSURBVHgB7VXbDcMgDHSjDpCRMgojZIOwQdMJ6CYZiRFco7qSi3gYSqV+5KSTcOTzEZAOgH8EIm7QgyAkeuat0IPQijAQX3DEB69tanivQdi1E3Uw8anhEQ6iyc2dSp5Rfcn0LURXvZdwHOKIHK/3TA9yPRNX8TdLzWQXzTbTs8Z3IIwPqEHusNBjonpmmYcRBi26CX6M0+A0GGwg8wQzcZ2CSoeKuP5Kh5W4LhgUdS1xrcWH7irWd+Im4sTwtxr0Oo7r95tsQYle3RA8AW71bDMxGCXJAAAAAElFTkSuQmCC )
22
26
![ GitHub closed pull requests] ( https://img.shields.io/github/issues-pr-closed-raw/arup-group/adsec-grasshopper?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAPCAYAAADtc08vAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAACbSURBVHgBnVJbEYAgELwIRCCCEYxgBJtoBBsYwQhGuQhEOL2Zc1wRFNgZPoB9sABRA0TEncNTC1QoN1ytWJMZDHyNXg1WEM+xs/8RjyDeKNOpy4iVE4zDjzBLv7BnDBg4Q4qwAKGP9qZk74jk8IiwPoCY6QvqjknWm20epOTJIsEGhiOVQPvLGyvVQF8Ce0vDd+3AwFML7AKLkg/1iD3k8fl0tQAAAABJRU5ErkJggg== )
23
27
![ GitHub commit activity] ( https://img.shields.io/github/commit-activity/m/arup-group/adsec-grasshopper?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAC7SURBVHgB7VWBDYMwDMt2wU7gBE7ZCftg/WD9YPuAE3bCTukJOyEkUpBCRdsUgRAISxUlqe1ErVqAE2sDEQMmwPkr7AVUcBN3YyE5Gp7JFeLBZED5tyqGSa1RvCkaUO6uxL9q7kriEk8bRCQvMa9MXjlxyfF/SBl0QvpFcRd1NSmeBS185ki8Dzg+KVXi3PJfiI/Cuo+MG1ihKutgafDGqZbtVVUYDCeihROHw2WYJO+OucIE/u7nwdkMPUCUeIAsCfP+AAAAAElFTkSuQmCC )
24
28
![ GitHub top language] ( https://img.shields.io/github/languages/top/arup-group/adsec-grasshopper?logo=dotnet&style=flat-square )
@@ -28,14 +32,37 @@ Pull requests are welcome. For major changes, please open an issue first to disc
28
32
29
33
Please make sure to update tests as appropriate.
30
34
35
+ ## Development
36
+
37
+ You will need to setup [ pre-commit] ( https://pre-commit.com/ ) for doing development.
38
+
39
+ ``` bash
40
+ # Setup virtual environment (.venv is excluded by default on the gitignore)
41
+ python -m venv .venv
42
+ # Activate virtual environment
43
+ .\. venv\S cripts\a ctivate
44
+ # Install pre-commit
45
+ pip install pre-commit
46
+ # Install commitizen
47
+ pip install Commitizen
48
+ # Install and Add commit-msg and pre-push hook types
49
+ pre-commit install --hook-type commit-msg --hook-type pre-push
50
+ # Setup Hooks (repeat on new branches where the configuration might be different)
51
+ pre-commit install
52
+ ```
53
+
54
+
55
+
31
56
## License
57
+
32
58
[ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-yellow.svg?&style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAADLSURBVHgB7ZPRDcIwDESvnYAROgIbkA1ghG7CKDACTNBs0m5QNgiO5I/IuLGLhJCgT7JUWXe5OHKBvyIxazytckhIC8gghQDHLYf0PoN1eFe7jZzE45NPdC6+T/Bj+yh5J8adc09oXiawfG0lOYt62FR9ZcBRMQfY+Hw8mmQWGu2Jqr6mNEOhIaRG6y35yieKiu4Gm+jy8S5feeRcF+cWmT43WoBFiw+zBXw/oNGavGY91YFqz+1OyB5UE9edKtK/NcEDBYxpPSN+kidmAJvClBsULQAAAABJRU5ErkJggg== )] ( /LICENSE )
33
59
34
60
The plugin is free to download but can only be loaded with a license for AdSec API available. Contact Oasys for a free trial. For licensing of AdSec and AdSec API refer to Oasys Software [ licensing terms] ( https://www.oasys-software.com/support/licensing-of-oasys-software/ ) .
35
61
36
62
For third party packages used by AdSec-Grasshopper, the individual licenses apply. See a list of these in the [ 'License'] ( /AdSecGH/licenses ) subfolder of each project.
37
63
38
64
## About
65
+
39
66
[](https://www.oasys-software.com/products/adsec/)
40
67
41
68
AdSec-Grasshopper is a plugin for Grasshopper wrapping Oasys AdSec's [ .NET API] ( https://arup-group.github.io/oasys-combined/adsec-api/ ) . The plugin allows users of Grasshopper to create, edit and analyse AdSec sections seemlesly. AdSecGH requires a licensed version of [ AdSec API] ( https://www.oasys-software.com/products/adsec/ ) .
0 commit comments