Skip to content

Commit e735f86

Browse files
author
Markku Laine
committed
docs(README): update README to include instructions for using Miniconda
1 parent f729893 commit e735f86

File tree

2 files changed

+6
-12
lines changed

2 files changed

+6
-12
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ First, the metric must be listed in a suitable category under the `categories` k
2323

2424
| Key | Description |
2525
|:--------|:------------|
26-
| id | Category ID |
2726
| name | Category name |
2827
| icon | Category icon |
2928
| metrics | List of metric IDs belonging to this category |

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ AIM can also be installed and run without Docker. While this installation proces
9393

9494
Make sure you have the following software already installed on your computer before proceeding!
9595

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.
9797

9898
### Configuration
9999

@@ -148,31 +148,26 @@ Alternatively, on Windows, you need to manually download a *matching* version of
148148

149149
In the next step, we will create a new Python virtual environment (recommended) for the backend. Before proceeding, go to the [backend](./backend/) directory.
150150

151-
#### Working with `virtualenv`
151+
#### Working with `Miniconda`
152152

153153
Create a new virtual environment:
154154
```sh
155-
virtualenv ../venv
155+
conda create -n aim2 python=3.7
156156
```
157157

158158
Activate the virtual environment:
159159
```sh
160-
source ../venv/bin/activate
160+
conda activate aim2
161161
```
162162

163163
Install all dependencies, including development packages:
164164
```sh
165165
pip install -r requirements.txt
166166
```
167167

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):
169-
```sh
170-
deactivate && source ../venv/bin/activate
171-
```
172-
173168
To deactivate the virtual environment, run:
174169
```sh
175-
deactivate
170+
conda deactivate
176171
```
177172

178173
### Frontend
@@ -259,7 +254,7 @@ python screenshoter.py -i data/screenshots/ALEXA_500/urls.csv -sw 1280 -sh 800 -
259254

260255
## Evaluator App <a name="evaluator"></a>
261256

262-
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.
263258

264259
### Configuration
265260

0 commit comments

Comments
 (0)