Skip to content

Commit

Permalink
Merge README (#356)
Browse files Browse the repository at this point in the history
* Fix `WindowsError` (#343)

* Fix `WindowsError`

`subprocess.CalledProcessError` only works if git client is installed

* Update version number

* Update README.md (#354)

* Update README.md
  • Loading branch information
Jens West committed Aug 27, 2021
1 parent 0f9db84 commit 9812cb0
Showing 1 changed file with 26 additions and 18 deletions.
44 changes: 26 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,46 +6,54 @@ This repository contains python files for Helmet 4.1 Model System. Source codes

## Usage

In this chapter, we will guide you how to install HELMET 4.1 to work with INRO Emme software. The user is not expected to install any new software apart from [helmet-model-system](https://github.com/HSLdevcom/helmet-model-system) and [helmet-ui](https://github.com/HSLdevcom/helmet-ui).
You can run HELMET 4.1 from the command line or by using [helmet-ui](https://github.com/HSLdevcom/helmet-ui).
In this chapter, we will guide you how to install HELMET 4.1 to work with Inro EMME software from the command line.
The user is not expected to install any new software apart from [helmet-model-system](https://github.com/HSLdevcom/helmet-model-system) and EMME.

If you do not have an Emme license or you wish to develop HELMET 4.1 further, please scroll down to [Development](#development) chapter.

### Setup

In production, we are using Python 3.7 which is supported by and installed together with INRO Emme 4.5 software.
From this repository, copy the contents of the [Scripts](Scripts) folder to your computer.

We are using those Python dependencies that come with INRO Emme installation. To get access to these dependencies, you need to add them to your local PATH variable:
In production, we are using Python 3.7 which is supported by and installed together with INRO Emme software.
We are using those Python dependencies that come with Inro EMME installation.
To get access to these dependencies, you need to add them to your local PATH variable:

1. Open Control Panel.
2. Go to User Accounts, then click again User Accounts, then select from the left hand menu "Change my environment variables".
3. From the top box ("User variables for USERNAME"), find and select "Path" variable, and click "Edit...".
4. Click "New" and write `%EMMEPATH%\Programs`.
5. Click OK in the "Edit environment variable" window, and then click OK again in the "Environment Variables" window.
5. Click "New" and write `%EMMEPATH%\Python37`.
6. Click "New" and write `%EMMEPATH%\Python37\Scripts`.
7. Click OK in the "Edit environment variable" window, and then click OK again in the "Environment Variables" window.

Next, you need to initialize an Emme project:
Emme assignment can be tested without further configuration.
Open command line to your local Scripts folder and write:

```
python test_assignment.py
```

This will create a small EMME test network and run test assignments on it.

You can also initialize a proper Emme project (if you do not want to use the test network):

1. Open Emme desktop application.
2. Create new project called `helmet-model-system` in which the path should match your project name and path.
- The wizard should create you a (large binary) file called `helmet-model-system.emp` inside your project folder
3. Follow external instructions to configure the details of the Emme project. Now, your working folder is filled with Emme project specific folders and files.
4. From this repository, copy the contents of the [Scripts](Scripts) folder to the "Scripts" folder in the Emme project.
2. Create new project in which the path should match your project name and path.
3. Follow [external instructions](https://hsldevcom.github.io/helmet-ui/sijopankki.html) to configure the details of the Emme project.
Now, your working folder is filled with Emme project specific folders and files.

### Running

You can run HELMET 4.1 from the command line or by using [helmet-ui](https://github.com/HSLdevcom/helmet-ui). Before running from the command line, set the configurations in [dev-config.json](Scripts/dev-config.json). Then, open command line to your Emme project and type:
Before running from the command line, set the configurations in [dev-config.json](Scripts/dev-config.json).
Instructions on the configuration settings are found [here](Scripts#running-the-model-system).
Then, open command line to your local Scripts folder:

```
cd Scripts
python helmet.py
```

Emme assignment can be tested without further configuration:

```
cd Scripts
python test_assignment.py
```

## Development

If you do not have INRO Emme license or you wish to develop HELMET 4.1 source code, you need to set up a development environment. Although not covered here, installing [Git](https://git-scm.com/downloads) is highly recommended!
Expand Down

0 comments on commit 9812cb0

Please sign in to comment.