You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-11Lines changed: 6 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,7 +93,7 @@ AIM can also be installed and run without Docker. While this installation proces
93
93
94
94
Make sure you have the following software already installed on your computer before proceeding!
95
95
96
-
The backend dependencies include [Python 3.7](https://www.python.org/), [pip](https://pypi.org/project/pip/), [MongoDB](https://www.mongodb.com/), and [Chrome](https://www.google.com/chrome/). In addition, it is highly recommended to install [virtualenv](https://pypi.org/project/virtualenv/) to create a dedicated Python virtual environment (see [instructions](#installation_backend)). Other dependencies include [Node.js 16.14.2](https://nodejs.org/) and [npm](https://www.npmjs.com/) for the frontend and [git](https://git-scm.com/) to track changes made to the codebase.
96
+
The backend dependencies include [Python 3.7](https://www.python.org/), [pip](https://pypi.org/project/pip/), [MongoDB](https://www.mongodb.com/), and [Chrome](https://www.google.com/chrome/). In addition, it is highly recommended to install [Miniconda](https://docs.conda.io/en/latest/miniconda.html) to create a dedicated Python virtual environment (see [instructions](#installation_backend)). Other dependencies include [Node.js 16.14.2](https://nodejs.org/) and [npm](https://www.npmjs.com/) for the frontend and [git](https://git-scm.com/) to track changes made to the codebase.
97
97
98
98
### Configuration
99
99
@@ -148,31 +148,26 @@ Alternatively, on Windows, you need to manually download a *matching* version of
148
148
149
149
In the next step, we will create a new Python virtual environment (recommended) for the backend. Before proceeding, go to the [backend](./backend/) directory.
150
150
151
-
#### Working with `virtualenv`
151
+
#### Working with `Miniconda`
152
152
153
153
Create a new virtual environment:
154
154
```sh
155
-
virtualenv ../venv
155
+
conda create -n aim2 python=3.7
156
156
```
157
157
158
158
Activate the virtual environment:
159
159
```sh
160
-
source ../venv/bin/activate
160
+
conda activate aim2
161
161
```
162
162
163
163
Install all dependencies, including development packages:
164
164
```sh
165
165
pip install -r requirements.txt
166
166
```
167
167
168
-
Re-activate the virtual environment to update paths (see [Stack Overflow](https://stackoverflow.com/questions/35045038/how-do-i-use-pytest-with-virtualenv) for details):
AIM backend also provides a utility app for evaluating GUI designs (i.e., web page screenshots) against selected metrics. The app generates three files: `results.csv`, `results.json`, and `quantiles.csv`. Two former files contain evaluation results, while the latter file contains statistics. Optionally, it also generates histogram figures for each metric. To configure and run the app, go to the [backend](./backend/) directory and follow the instructions below.
257
+
AIM backend also provides a utility app for evaluating GUI designs (i.e., web page screenshots) against selected metrics. The app generates two files: `results.csv`and `quantiles.csv`. Tthe former file contains evaluation results, while the latter file contains statistics. In addition, it also generates`<YOUR_METRIC_ID>_results.json` files and optional histogram figures for each metric. To configure and run the app, go to the [backend](./backend/) directory and follow the instructions below.
0 commit comments