From 890f9e945de17384654dd0b736613ea90f2c7718 Mon Sep 17 00:00:00 2001
From: Gonzalo Casas <casas@arch.ethz.ch>
Date: Mon, 6 May 2024 14:30:27 +0200
Subject: [PATCH] add install docs page

---
 README.md                |  16 +++++--
 docs/installation.rst    | 101 +++++++++++++++++++++++++++++++++++++++
 environment.yml          |   2 +-
 src/aixd_ara/__init__.py |   5 ++
 4 files changed, 118 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 4b31922..73ed6fc 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# AI-eXtended Design (AIXD): Grasshopper plugin
+# ARA: AIXD Grasshopper plugin
 
 Grasshopper plugin for the AIXD toolkit.
 
@@ -11,16 +11,22 @@ Grasshopper plugin for the AIXD toolkit.
 - flask
 
 #### Latest stable version
+
 Install `aixd_ara` using `pip`
-```
+```bash
 pip install aixd_ara
 ```
 
 Install `aixd_ara` using `conda`:
-```
+```bash
 conda install -c conda-forge aixd_ara
 ```
 
+Install the plugin in Rhino/GH using the following command:
+```bash
+python -m compas_rhino.install -v 7.0
+```
+
 **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_ara`.
@@ -28,7 +34,7 @@ conda install -c conda-forge aixd_ara
 #### Latest unstable version
 
 Install the latest version using `pip` from the git repository:
-```
+```bash
 pip install --upgrade git+https://github.com/gramaziokohler/aixd_ara.git
 ```
 
@@ -41,7 +47,7 @@ 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`:
+Then, use conda to install all the dependencies into a new environment called `aixd_ara`:
 ```bash
 conda env create -f environment.yml
 ```
diff --git a/docs/installation.rst b/docs/installation.rst
index a2d3ef9..08e3365 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -1,3 +1,104 @@
 ********************************************************************************
 Installation
 ********************************************************************************
+
+This page provides a guide for installing the ``ARA`` plugin on your system.
+The plugin can be installed using an installer, or a package manager for Python such as ``pip`` or ``conda``.
+
+The following instructions will guide you through each method.
+Alternatively, you can clone the ``aixd_ara`` source code directly from
+our `repository <https://github.com/gramaziokohler/aixd_ara>`_.
+
+One-click installer
+===================
+
+The one-click installer is the easiest way to install the plugin on your system:
+
+* Download the ZIP files.
+* Extract them in any forlder.
+* Run the installer file.
+
+Installation using pip
+======================
+
+The most popular package manager for Python is ``pip``.
+You can use it to install packages from the Python Package Index and other indexes.
+
+**Step 1: Update pip**
+
+It is good practice to ensure that you are using the latest version of ``pip``.
+To update ``pip``, run the following command:
+
+
+.. code-block:: bash
+
+    python -m pip install --upgrade pip
+
+**Step 2: Install plugin**
+
+To install `ara_aixd` using ``pip``, execute the following command:
+
+.. code-block:: bash
+
+    pip install ara_aixd
+
+And then install the plugin in Rhino/GH using the following command:
+
+.. code-block:: bash
+
+    python -m compas_rhino.install -v 7.0
+
+
+Installation using conda
+========================
+
+``conda`` is an open-source package management system and environment
+ management system that runs on Windows, macOS, and Linux.
+ It’s very popular in the realm of scientific computing.
+
+**Step 1: Create a conda environment (Optional)**
+
+It's often beneficial to create a new environment for your project. This can be done using the following command:
+
+.. code-block:: bash
+
+    conda create --name project_name python=3.x
+
+
+Replace *project_name* with your desired environment name and *3.x* with the
+specific version of Python you want to use.
+This package requires python 3.9 or a higher.
+
+Activate the new environment by running:
+
+.. code-block:: bash
+
+    conda activate project_name
+
+**Step 2: Install plugin**
+
+To install ``aixd_ara`` in your ``conda`` environment, use the following command:
+
+.. code-block:: bash
+
+    conda install -c conda-forge aixd_ara
+
+Finally, install the plugin in Rhino/GH using the following command:
+
+.. code-block:: bash
+
+    python -m compas_rhino.install -v 7.0
+
+
+Verify installation
+===================
+
+After installation, you can verify that the plugin has been successfully installed by running:
+
+.. code-block:: bash
+
+    python -c "import aixd_ara; print(aixd_ara.__version__)"
+
+
+If everything worked out correctly, the version of the installed plugin will be printed on
+the screen, and you can start using the plugin in your projects.
diff --git a/environment.yml b/environment.yml
index 82ed161..682dca2 100644
--- a/environment.yml
+++ b/environment.yml
@@ -1,4 +1,4 @@
-name: aixd_gh
+name: aixd_ara
 channels:
     - conda-forge
 dependencies:
diff --git a/src/aixd_ara/__init__.py b/src/aixd_ara/__init__.py
index e69de29..85a689d 100644
--- a/src/aixd_ara/__init__.py
+++ b/src/aixd_ara/__init__.py
@@ -0,0 +1,5 @@
+__author__ = ["Aleksandra Apolinarska"]
+__copyright__ = "Copyright (c) 2023-2024 ETH Zurich, Gramazio Kohler Research"
+__license__ = "MIT License"
+__email__ = "apolinarska@arch.ethz.ch"
+__version__ = "0.1.0"