Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #31

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,42 @@ it needs to be included while running them.

1. Set the home environment variable

Mac:

```
$ export EMISSION_SERVER_HOME=<path_to_emission_server_repo>
```

In windows command prompt use:

```
> set EMISSION_SERVER_HOME=<path_to_emission_server_repo>
```
Comment on lines +18 to +22
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have to support windows? We are not testing the windows codepaths regularly, and I am concerned that this will just bitrot and then we have to debug it all over again. Can we at least indicate that windows is unsupported and people are using it at their own risk?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@allenmichael099 are you planning to resolve this so that I can merge it?


1. If you haven't setup before, set up the evaluation system

Mac:
```
$ source setup.sh
```

Windows:
```
> call setup.sh
```

1. If you have, activate

```
$ source activate.sh
```

```
call activate.sh
```

1. Access the visualizations of interest and copy the config over

1. Access the visualizations of interest and copy the config folder from the e-mission-server folder to your eval_folder.
The 'eval_folder' in this context is e-mission-eval-private-data.
```
$ cd <eval_folder>
$ cp -r ../conf .
Expand Down