Merge pull request #33 from gramaziokohler/rename

Rename to `aixd_ara`

.bumpversion.cfg

@@ -8,10 +8,10 @@ tag = True
 search = version="{current_version}"
 replace = version="{new_version}"
 
-[bumpversion:file:src/aixd_grasshopper/__init__.py]
+[bumpversion:file:src/aixd_ara/__init__.py]
 search = __version__ = "{current_version}"
 replace = __version__ = "{new_version}"
 
 [bumpversion:file:CHANGELOG.md]
 search = Unreleased
-replace = [{new_version}] {now:%Y-%m-%d}
+replace = [{new_version}] {now:%Y-%m-%d}

.gitignore

@@ -101,7 +101,7 @@ ENV/
 .mypy_cache/
 
 # ==============================================================================
-# aixd_grasshopper
+# aixd_ara
 # ==============================================================================
 
 *.3dmbak
@@ -116,6 +116,6 @@ temp/**
 .vscode
 
 docs/api/generated/
-src/aixd_grasshopper/components/ghuser/
+src/aixd_ara/components/ghuser/
 
 conda.recipe/

CONTRIBUTING.md

@@ -7,7 +7,7 @@ Contributions are welcome and very much appreciated!
 We accept code contributions through pull requests.
 In short, this is how that works.
 
-1. Fork [the repository](https://github.com/gramaziokohler/aixd_grasshopper) and clone the fork.
+1. Fork [the repository](https://github.com/gramaziokohler/aixd_ara) and clone the fork.
 2. Create a virtual environment using your tool of choice (e.g. `virtualenv`, `conda`, etc).
 3. Install development dependencies:
 
@@ -44,15 +44,15 @@ command line to ease recurring operations:
 
 ## Bug reports
 
-When [reporting a bug](https://github.com/gramaziokohler/aixd_grasshopper/issues) please include:
+When [reporting a bug](https://github.com/gramaziokohler/aixd_ara/issues) please include:
 
 * Operating system name and version.
 * Any details about your local setup that might be helpful in troubleshooting.
 * Detailed steps to reproduce the bug.
 
 ## Feature requests
 
-When [proposing a new feature](https://github.com/gramaziokohler/aixd_grasshopper/issues) please include:
+When [proposing a new feature](https://github.com/gramaziokohler/aixd_ara/issues) please include:
 
 * Explain in detail how it would work.
 * Keep the scope as narrow as possible, to make it easier to implement.

README.md

@@ -11,34 +11,34 @@ Grasshopper plugin for the AIXD toolkit.
 - flask
 
 #### Latest stable version
-Install `aixd_grasshopper` using `pip`
+Install `aixd_ara` using `pip`
 ```
-pip install aixd_grasshopper
+pip install aixd_ara
 ```
 
-Install `aixd_grasshopper` using `conda`:
+Install `aixd_ara` using `conda`:
 ```
-conda install -c conda-forge aixd_grasshopper
+conda install -c conda-forge aixd_ara
 ```
 
 **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`.
+`conda activate myproject` before installing `aixd_ara`.
 
 #### Latest unstable version
 
 Install the latest version using `pip` from the git repository:
 ```
-pip install --upgrade git+https://github.com/gramaziokohler/aixd_grasshopper.git
+pip install --upgrade git+https://github.com/gramaziokohler/aixd_ara.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
+git clone https://github.com/gramaziokohler/aixd_ara.git
+cd aixd_ara
 ```
 
 Then, install using conda, to install all the dependencies into a new environment called `aixd_gh`:
@@ -67,7 +67,7 @@ Check the [contribution guidelines](CONTRIBUTING.md) for more details.
 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/aixd_ara` : source code of `aixd_ara` plugin.
+    * `src/aixd_ara/components` : source code of the GH components.
+    * `src/aixd_ara/ghuser_manual` : binary components, pre-built.
     * `src/compas_aixd` : source code of the connector to COMPAS infrastructure.

conftest.py

@@ -4,7 +4,7 @@
 import numpy
 import pytest
 
-import aixd_grasshopper
+import aixd_ara
 
 
 def pytest_ignore_collect(path):
@@ -24,8 +24,8 @@ def add_compas(doctest_namespace):
 
 
 @pytest.fixture(autouse=True)
-def add_aixd_grasshopper(doctest_namespace):
-    doctest_namespace["aixd_grasshopper"] = aixd_grasshopper
+def add_aixd_ara(doctest_namespace):
+    doctest_namespace["aixd_ara"] = aixd_ara
 
 
 @pytest.fixture(autouse=True)

docs/_static/versions.json

@@ -2,6 +2,6 @@
     {
         "name": "latest",
         "version": "unreleased",
-        "url": "https://gramaziokohler.github.io/aixd_grasshopper/latest/"
+        "url": "https://gramaziokohler.github.io/aixd_ara/latest/"
     }
-]
+]

docs/authors.rst

@@ -6,7 +6,7 @@ Authors
 
 **ARA** is developed by Aleksandra Anna Apolinarska, together with Gonzalo Casas at
 `ETH Zurich <https://ethz.ch/>`_
-(`Gramazio Kohler Research <https://gramaziokohler.arch.ethz.ch/>`_, 
+(`Gramazio Kohler Research <https://gramaziokohler.arch.ethz.ch/>`_,
 and Luis Salamanca at
 `Swiss Data Science Center <https://www.datascience.ch/>`_.
 
@@ -22,5 +22,5 @@ If you use **ARA** in your work, please cite it as:
     author = {Apolinarska, Aleksandra Anna and Casas, Gonzalo and Salamanca, Luis},
     year = {2024},
     publisher = {GitHub},
-    howpublished = {\url{https://github.com/gramaziokohler/aixd_grasshopper}},
+    howpublished = {\url{https://github.com/gramaziokohler/aixd_ara}},
     }

docs/conf.py

@@ -10,7 +10,7 @@
 project = "ARA"
 copyright = "Copyright (c) 2023-2024 ETH Zurich, Gramazio Kohler Research"
 author = "Aleksandra Apolinarska"
-package = "aixd_grasshopper"
+package = "aixd_ara"
 organization = "gramaziokohler"
 
 master_doc = "index"

docs/examples.rst

@@ -7,5 +7,5 @@ Examples
 
 Here you can find examples showinf the basic workflow using **ARA** in Grasshopper.
 
-- Bridge shell: `see here <https://github.com/gramaziokohler/aixd_grasshopper/tree/main/examples/bridge_shell>`__
-- Urban massing: `see here <https://github.com/gramaziokohler/aixd_grasshopper/tree/main/examples/urban_massing>`__
+- Bridge shell: `see here <https://github.com/gramaziokohler/aixd_ara/tree/main/examples/bridge_shell>`__
+- Urban massing: `see here <https://github.com/gramaziokohler/aixd_ara/tree/main/examples/urban_massing>`__

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.black]
 line-length = 120
-extend-exclude = "src/aixd_grasshopper/components"
+extend-exclude = "src/aixd_ara/components"
 
 [tool.pytest.ini_options]
 minversion = "6.0"
@@ -21,8 +21,8 @@ force_grid_wrap = 0
 use_parentheses = true
 force_single_line = true
 ensure_newline_before_comments = true
-known_first_party = "aixd_grasshopper"
+known_first_party = "aixd_ara"
 default_section = "THIRDPARTY"
-forced_separate = "test_aixd_grasshopper"
+forced_separate = "test_aixd_ara"
 skip = ["__init__.py"]
 

scripts/generate_rst_docs_from_components.ipynb

@@ -10,7 +10,7 @@
     "\n",
     "current_dir = os.getcwd()\n",
     "parent_dir = os.path.dirname(current_dir)\n",
-    "GHCOMP_FOLDER = os.path.join(parent_dir, \"src\",\"aixd_grasshopper\",\"components\")\n",
+    "GHCOMP_FOLDER = os.path.join(parent_dir, \"src\",\"aixd_ara\",\"components\")\n",
     "OUTPUT_PATH = os.path.join(parent_dir, \"docs\")\n"
    ]
   },

setup.py

@@ -22,12 +22,12 @@ def read(*names, **kwargs):
 requirements = read("requirements.txt").split("\n")
 
 setup(
-    name="aixd_grasshopper",
+    name="aixd_ara",
     version="0.1.0",
     description="Grasshopper plugin for the AIXD toolkit",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/gramaziokohler/aixd_grasshopper",
+    url="https://github.com/gramaziokohler/aixd_ara",
     author="Aleksandra Apolinarska",
     author_email="[email protected]",
     license="MIT license",
@@ -48,7 +48,7 @@ def read(*names, **kwargs):
     ],
     keywords=[],
     project_urls={},
-    packages=["aixd_grasshopper", "compas_aixd"],
+    packages=["aixd_ara", "compas_aixd"],
     package_dir={"": "src"},
     package_data={},
     data_files=[],

src/aixd_grasshopper/api.py → src/aixd_ara/api.py

@@ -4,8 +4,8 @@
 from flask import Flask
 from flask import request
 
-from aixd_grasshopper.constants import DEFAULT_PORT
-from aixd_grasshopper.controller import SessionController
+from aixd_ara.constants import DEFAULT_PORT
+from aixd_ara.controller import SessionController
 
 app = Flask(__name__)
 

src/aixd_grasshopper/components/aixd_DataBool/code.py → src/aixd_ara/components/aixd_DataBool/code.py

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

src/aixd_grasshopper/components/aixd_DataCat/code.py → src/aixd_ara/components/aixd_DataCat/code.py

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

src/aixd_grasshopper/components/aixd_DataInt/code.py → src/aixd_ara/components/aixd_DataInt/code.py

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

src/aixd_grasshopper/components/aixd_DataObjectsNames/code.py → src/aixd_ara/components/aixd_DataObjectsNames/code.py

@@ -6,8 +6,8 @@
 import Grasshopper
 import System.Drawing as sd
 
-from aixd_grasshopper.gh_ui import get_dataobject_names_from_block
-from aixd_grasshopper.gh_ui_helper import session_id
+from aixd_ara.gh_ui import get_dataobject_names_from_block
+from aixd_ara.gh_ui_helper import session_id
 
 comp = ghenv.Component
 ghdoc = comp.OnPingDocument()

src/aixd_grasshopper/components/aixd_DataReal/code.py → src/aixd_ara/components/aixd_DataReal/code.py

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

src/aixd_grasshopper/components/aixd_DatasetCreate/code.py → src/aixd_ara/components/aixd_DatasetCreate/code.py

@@ -1,9 +1,9 @@
 # flake8: noqa
 from scriptcontext import sticky as st
 
-from aixd_grasshopper.gh_ui import create_dataset_object
-from aixd_grasshopper.gh_ui_helper import component_id
-from aixd_grasshopper.gh_ui_helper import session_id
+from aixd_ara.gh_ui import create_dataset_object
+from aixd_ara.gh_ui_helper import component_id
+from aixd_ara.gh_ui_helper import session_id
 
 cid = component_id(session_id(), ghenv.Component, "DatasetCreate")
 

src/aixd_grasshopper/components/aixd_DatasetGenerator/code.py → src/aixd_ara/components/aixd_DatasetGenerator/code.py

@@ -1,4 +1,4 @@
-from aixd_grasshopper.scripts import dataset_generator
+from aixd_ara.scripts import dataset_generator
 
 path = dataset_generator.__file__
 

src/aixd_grasshopper/components/aixd_DatasetLoad/code.py → src/aixd_ara/components/aixd_DatasetLoad/code.py

@@ -1,9 +1,9 @@
 # flake8: noqa
 from scriptcontext import sticky as st
 
-from aixd_grasshopper.gh_ui import load_dataset
-from aixd_grasshopper.gh_ui_helper import component_id
-from aixd_grasshopper.gh_ui_helper import session_id
+from aixd_ara.gh_ui import load_dataset
+from aixd_ara.gh_ui_helper import component_id
+from aixd_ara.gh_ui_helper import session_id
 
 cid = component_id(session_id(), ghenv.Component, "DatasetLoad")
 

src/aixd_grasshopper/components/aixd_DatasetOneSample/code.py → src/aixd_ara/components/aixd_DatasetOneSample/code.py

@@ -1,10 +1,10 @@
 # flake8: noqa
 from scriptcontext import sticky as st
 
-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 instantiate_sample, sample_summary
-from aixd_grasshopper.gh_ui_helper import session_id
+from aixd_ara.gh_ui import get_one_sample
+from aixd_ara.gh_ui_helper import component_id
+from aixd_ara.gh_ui_helper import instantiate_sample, sample_summary
+from aixd_ara.gh_ui_helper import session_id
 
 cid = component_id(session_id(), ghenv.Component, "GetOneSample")
 

src/aixd_grasshopper/components/aixd_DatasetSummary/code.py → src/aixd_ara/components/aixd_DatasetSummary/code.py

@@ -1,9 +1,9 @@
 # flake8: noqa
 from scriptcontext import sticky as st
 
-from aixd_grasshopper.gh_ui import dataset_summary
-from aixd_grasshopper.gh_ui_helper import component_id
-from aixd_grasshopper.gh_ui_helper import session_id
+from aixd_ara.gh_ui import dataset_summary
+from aixd_ara.gh_ui_helper import component_id
+from aixd_ara.gh_ui_helper import session_id
 
 cid = component_id(session_id(), ghenv.Component, "DatasetSummary")
 

src/aixd_grasshopper/components/aixd_Generator/code.py → src/aixd_ara/components/aixd_Generator/code.py

@@ -2,19 +2,19 @@
 
 from scriptcontext import sticky as st
 
-from aixd_grasshopper.gh_ui import get_dataobject_types
-from aixd_grasshopper.gh_ui import request_designs
-from aixd_grasshopper.gh_ui_helper import component_id
-from aixd_grasshopper.gh_ui_helper import instantiate_sample
-from aixd_grasshopper.gh_ui_helper import sample_summary as sample_summary_f
-from aixd_grasshopper.gh_ui_helper import session_id
-from aixd_grasshopper.gh_ui_helper import reformat_request
+from aixd_ara.gh_ui import get_dataobject_types
+from aixd_ara.gh_ui import request_designs
+from aixd_ara.gh_ui_helper import component_id
+from aixd_ara.gh_ui_helper import instantiate_sample
+from aixd_ara.gh_ui_helper import sample_summary as sample_summary_f
+from aixd_ara.gh_ui_helper import session_id
+from aixd_ara.gh_ui_helper import reformat_request
 
 cid = component_id(session_id(), ghenv.Component, "run_generation")
 item = component_id(session_id(), ghenv.Component, "pick_sample")
 
 """
-requested_values: a multiline string with variable_name:values tuples. 
+requested_values: a multiline string with variable_name:values tuples.
 """
 
 if not n_designs or n_designs < 1:

src/aixd_grasshopper/components/aixd_ModelDims/code.py → src/aixd_ara/components/aixd_ModelDims/code.py

@@ -1,9 +1,9 @@
 # flake8: noqa
 from scriptcontext import sticky as st
 
-from aixd_grasshopper.gh_ui import model_input_output_dimensions
-from aixd_grasshopper.gh_ui_helper import component_id
-from aixd_grasshopper.gh_ui_helper import session_id
+from aixd_ara.gh_ui import model_input_output_dimensions
+from aixd_ara.gh_ui_helper import component_id
+from aixd_ara.gh_ui_helper import session_id
 
 cid = component_id(session_id(), ghenv.Component, "ModelDims")
 

src/aixd_grasshopper/components/aixd_ModelLoad/code.py → src/aixd_ara/components/aixd_ModelLoad/code.py

@@ -1,9 +1,9 @@
 # flake8: noqa
 from scriptcontext import sticky as st
 
-from aixd_grasshopper.gh_ui import model_load
-from aixd_grasshopper.gh_ui_helper import component_id
-from aixd_grasshopper.gh_ui_helper import session_id
+from aixd_ara.gh_ui import model_load
+from aixd_ara.gh_ui_helper import component_id
+from aixd_ara.gh_ui_helper import session_id
 
 cid = component_id(session_id(), ghenv.Component, "ModelLoad")