[do not merge] Params Class Tutorial #665
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Pull request information - *Status*: In development - *Kind of changes*: Additional tutorial - *Related PR or issue*: resolves issue #206 ## Description This tutorial walks you through the use of different parameters within the classes. Understanding how these classes work is fundamental in designing your own scenarios in Flow. The classes featured in this tutorial are `InitialConfig`,`SumoCarFollowingParams`, `SumoParams` and `EnvParams`. Each of these classes is detailed on their corresponding sections in this tutorial. This tutorial uses the classical Sugiyama experiment involving a loop (ring road) with a single lane and a fixed number of vehicles on it, similar to Tutorial 01. This one though focuses on the use of the parameters in the classes. ### This tutorial is divided into four (4) sections and is organized as follows: 1. `InitialConfig` 2. `SumoCarFollowingParams` 3. `SumoParams` 4. `EnvParams`
albenbagabaldo
requested review from
AboudyKreidieh,
cathywu,
eugenevinitsky and
kanaadp
as code owners
albenbagabaldo
assigned albenbagabaldo and AboudyKreidieh and unassigned albenbagabaldo
Pull Request Test Coverage Report for Build 4347
💛 - Coveralls |
|
I tried to work on section 1. But with |
…rams_class_tutorial
AboudyKreidieh
requested changes
Aug 9, 2019
There was a problem hiding this comment.
Alright, a few comments:
- The sections are inconsistent right now. Let's have each section be of the form: description - list of parameters - example usage
- Some parameters are missing, e.g.
VehicleParams,SumoLaneChangeParams, etc... Can you add them? - Can you be specific about the TODO? What's wrong, and can we fix it?
Once these are resolved I'll make a next pass.
This is the version of the tutorial where I tried to address the comments given. Please review/make necessary changes/revert back to me for further editing. Thank you!
The version of the tutorial where the first set of comments are addressed. Please review/ feel free to edit/revert back to me if major changes shall be made. Thank you!
Please review/feel free to edit/revert back to me if major changes are needed. Thank you!
…rams_class_tutorial
…ct/flow into params_class_tutorial
|
@albenbagabaldo I added some widgets to the InitialConfig aspect of the tutorial that look like this:
Before we continue with the rest of the tutorial can you set up the cell with the widgets to start a simulation (when a button is pressed) with the initial_config parameters specified by the widgets? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request information
Description
This tutorial walks you through the use of different parameters within the classes. Understanding how these classes work is fundamental in designing your own scenarios in Flow.
The classes featured in this tutorial are
InitialConfig,SumoCarFollowingParams,SumoParamsandEnvParams. Each of these classes is detailed on their corresponding sections in this tutorial.This tutorial uses the classical Sugiyama experiment involving a loop (ring road) with a single lane and a fixed number of vehicles on it, similar to Tutorial 01. This one though focuses on the use of the parameters in the classes.
This tutorial is divided into four (4) sections and is organized as follows:
InitialConfigSumoCarFollowingParamsSumoParamsEnvParams