Updates

.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python: ['3.8', '3.9', '3.10']
+        python: ['3.9', '3.10', '3.11']
 
     steps:
       - uses: compas-dev/compas-actions.build@v3

.github/workflows/pr-checks.yml

@@ -4,7 +4,6 @@ on:
     types: [assigned, opened, synchronize, reopened, labeled, unlabeled]
     branches:
       - main
-      - master
 
 jobs:
   build:

.gitignore

@@ -116,5 +116,6 @@ temp/**
 .vscode
 
 docs/api/generated/
+src/aixd_grasshopper/components/ghuser/
 
 conda.recipe/

CONTRIBUTING.md

@@ -12,7 +12,7 @@ In short, this is how that works.
 3. Install development dependencies:
 
    ```bash
-   pip install -r requirements-dev.txt
+   pip install -e ".[dev]"
    ```
 
 4. Make sure all tests pass:
@@ -21,7 +21,7 @@ In short, this is how that works.
    invoke test
    ```
 
-5. Start making your changes to the **master** branch (or branch off of it).
+5. Start making your changes to the **main** branch (or branch off of it).
 6. Make sure all tests still pass:
 
    ```bash
@@ -39,6 +39,7 @@ command line to ease recurring operations:
 * `invoke check`: Run various code and documentation style checks.
 * `invoke docs`: Generate documentation.
 * `invoke test`: Run all tests and checks in one swift command.
+* `invoke build-ghuser-components`: Build Grasshopper components.
 * `invoke`: Show available tasks.
 
 ## Bug reports

MANIFEST.in

@@ -13,7 +13,6 @@ include AUTHORS.md
 include CHANGELOG.md
 include requirements.txt
 
-exclude requirements-dev.txt
 exclude pytest.ini .bumpversion.cfg .editorconfig
 exclude tasks.py
 exclude CONTRIBUTING.md

README.md

@@ -1,4 +1,73 @@
-# aixd_grasshopper
+# AI-eXtended Design (AIXD): Grasshopper plugin
 
-Grasshopper plugin for the AIXD toolkit
+Grasshopper plugin for the AIXD toolkit.
 
+## Installation
+
+#### Requirements:
+
+- Python >= 3.9
+- compas > 2.0
+- flask
+
+#### Latest stable version
+Install `aixd_grasshopper` using `pip`
+```
+pip install aixd_grasshopper
+```
+
+Install `aixd_grasshopper` using `conda`:
+```
+conda install -c conda-forge aixd_grasshopper
+```
+
+**Note**: It is recommended to use virtual environments to manage the dependencies of your projects. If you are using 
+`conda`, you can create a new environment with `conda create -n myproject python=3.9` and then activate it with
+`conda activate myproject` before installing `aixd_grasshopper`.
+
+#### Latest unstable version
+
+Install the latest version using `pip` from the git repository:
+```
+pip install --upgrade git+https://github.com/gramaziokohler/aixd_grasshopper.git
+```
+
+## Development
+
+If you are going to develop on this repository, perform an installation from source:
+
+```bash
+git clone https://github.com/gramaziokohler/aixd_grasshopper.git
+cd aixd_grasshopper
+```
+
+Then, install using conda, to install all the dependencies into a new environment called `aixd_gh`:
+```bash
+conda env create -f environment.yml
+```
+
+Or using pip:
+```bash
+pip install -e ".[dev]"
+```
+
+Finally, build Grasshopper components and install on Rhino/GH:
+
+```bash
+invoke build-ghuser-components
+python -m compas_rhino.install -v 7.0
+```
+
+For more details on how the process of building components work, refer to [this docs](https://github.com/compas-dev/compas-actions.ghpython_components).
+
+Check the [contribution guidelines](CONTRIBUTING.md) for more details.
+
+## Folders and structure
+
+The structure we follow on the current repo is as follows:
+
+* `src` : for all source code.
+    * `src/aixd_grasshopper` : source code of `aixd_grasshopper` plugin.
+    * `src/aixd_grasshopper/components` : source code of the GH components.
+    * `src/aixd_grasshopper/ghuser_manual` : binary components, pre-built.
+    * `src/compas_aixd` : source code of the connector to COMPAS infrastructure.

environment.yml

@@ -0,0 +1,11 @@
+name: aixd_gh
+channels:
+    - conda-forge
+dependencies:
+   - python=3.9
+   - compas >2,<3
+   - flask
+   - pip
+   - pip:
+     - -e ".[dev]"
+prefix: "/opt/conda"

pyproject.toml

@@ -1,9 +1,10 @@
 [tool.black]
 line-length = 120
+extend-exclude = "src/aixd_grasshopper/components"
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-testpaths = ["tests", "src/aixd_grasshopper"]
+testpaths = ["tests"]
 python_files = [
     "test_*.py",
     "tests.py"

requirements-dev.txt

@@ -1,13 +1 @@
-attrs >=17.4
-black ==22.12.0
-bump2version >=1.0.1
-check-manifest >=0.36
-compas_invocations
-doc8
-flake8
-invoke >=0.14
-isort
-sphinx_compas2_theme
-twine
-wheel
--e .
+-e ".[dev]"

requirements.txt

@@ -1 +1,3 @@
 aixd >=0.10.0
+compas >2,<3
+flask

setup.py

@@ -21,7 +21,6 @@ def read(*names, **kwargs):
 
 long_description = read("README.md")
 requirements = read("requirements.txt").split("\n")
-optional_requirements = {}
 
 setup(
     name="aixd_grasshopper",
@@ -50,15 +49,31 @@ def read(*names, **kwargs):
     ],
     keywords=[],
     project_urls={},
-    packages=["aixd_grasshopper"],
+    packages=["aixd_grasshopper", "compas_aixd"],
     package_dir={"": "src"},
     package_data={},
     data_files=[],
     include_package_data=True,
     zip_safe=False,
     install_requires=requirements,
     python_requires=">=3.8",
-    extras_require=optional_requirements,
+    extras_require={
+        "dev": [
+            "attrs >=17.4",
+            "black",
+            "bump2version >=1.0.1",
+            "check-manifest >=0.36",
+            "compas_invocations >=1.0.0",
+            "doc8",
+            "flake8",
+            "invoke >=0.14",
+            "isort",
+            "pytest >=6.0",
+            "sphinx_compas2_theme",
+            "twine",
+            "wheel",
+        ],
+    },
     entry_points={
         "console_scripts": [],
     },

src/aixd_grasshopper/api.py

@@ -1,14 +1,11 @@
-import base64
-
-from flask import Flask, request
-
-
-from controller import SessionController
 import json
-from compas.data import DataEncoder, DataDecoder
 
+from compas.data import DataEncoder
+from flask import Flask
+from flask import request
 
-from aixd_grasshopper.constants import default_port
+from aixd_grasshopper.constants import DEFAULT_PORT
+from aixd_grasshopper.controller import SessionController
 
 app = Flask(__name__)
 
@@ -322,12 +319,12 @@ def model_input_output_dimensions():
     import sys
 
     if len(sys.argv) == 1:
-        port = default_port
+        port = DEFAULT_PORT
     else:
         try:
             port = int(sys.argv[1])
         except ValueError:
-            print("Invalid port number: ", sys.argv[1], "Setting a default port number {}".format(default_port))
-            port = default_port
+            print("Invalid port number: ", sys.argv[1], "Setting a default port number {}".format(DEFAULT_PORT))
+            port = DEFAULT_PORT
 
     app.run(host="127.0.0.1", port=port, debug=False)

src/aixd_grasshopper/components/__init__.py

@@ -1 +1 @@
-from __future__ import absolute_import
+from __future__ import absolute_import

src/aixd_grasshopper/components/aixd_DataBool/code.py

@@ -1,3 +1,4 @@
+# flake8: noqa
 from aixd_grasshopper.wrappers import WrapperShallowDataObject
 
 if not dim or dim < 1:

src/aixd_grasshopper/components/aixd_DataCat/code.py

@@ -1,3 +1,4 @@
+# flake8: noqa
 from aixd_grasshopper.wrappers import WrapperShallowDataObject
 
 if not dim or dim < 1:

src/aixd_grasshopper/components/aixd_DataInt/code.py

@@ -1,3 +1,4 @@
+# flake8: noqa
 from aixd_grasshopper.wrappers import WrapperShallowDataObject
 
 if not dim or dim < 1:

src/aixd_grasshopper/components/aixd_DataReal/code.py

@@ -1,3 +1,4 @@
+# flake8: noqa
 from aixd_grasshopper.wrappers import WrapperShallowDataObject
 
 if not dim or dim < 1:

src/aixd_grasshopper/components/aixd_DatasetCreate/code.py

@@ -1,3 +1,4 @@
+# flake8: noqa
 from aixd_grasshopper.gh_ui import create_dataset_object
 from aixd_grasshopper.gh_ui_helper import session_id, component_id
 from scriptcontext import sticky as st

src/aixd_grasshopper/components/aixd_DatasetLoad/code.py

@@ -1,3 +1,4 @@
+# flake8: noqa
 from aixd_grasshopper.gh_ui import load_dataset
 from aixd_grasshopper.gh_ui_helper import session_id, component_id
 from scriptcontext import sticky as st

src/aixd_grasshopper/components/aixd_DatasetOneSample/code.py

@@ -1,7 +1,9 @@
-from aixd_grasshopper.gh_ui import get_one_sample
-from aixd_grasshopper.gh_ui_helper import session_id, component_id
+# flake8: noqa
 import Grasshopper
 
+from aixd_grasshopper.gh_ui import get_one_sample
+from aixd_grasshopper.gh_ui_helper import component_id
+from aixd_grasshopper.gh_ui_helper import session_id
 
 if not item:
     item = -1

src/aixd_grasshopper/components/aixd_DatasetSummary/code.py

@@ -1,3 +1,4 @@
+# flake8: noqa
 from aixd_grasshopper.gh_ui import dataset_summary
 from aixd_grasshopper.gh_ui_helper import session_id, component_id
 from scriptcontext import sticky as st

src/aixd_grasshopper/components/aixd_GenSampleEval/code.py

@@ -1,3 +1,4 @@
+# flake8: noqa
 summarytxt = {}  # key =obj name, values= [req, pred, real]
 
 request_dict = {}