Docs examples #46

mattuntergassmair · 2020-03-10T11:28:56Z

improved examples in docs

work in progress, overlay tutorial still missing

as part of this PR, some defaults were changed:

default render mode is :basic rather than :fancy
default entity color determined based on vehicle id rather than COLOR_CAR_OTHER

I think the new defaults make more sense but this may be subjective and can be discussed / changed before closing the PR

coveralls · 2020-03-10T11:42:39Z

Coverage increased (+5.3%) to 53.576% when pulling d37c011 on mattuntergassmair:docs_examples into ecefe3a on sisl:master.

mattuntergassmair · 2020-03-10T11:35:14Z

docs/src/examples/basics.md

+
+You can use Reactive to have them endlessly drive in real time in your browser.
+
+### TODO: is this a thing? If yes, provide snippet


I've never used Reactive for visualizing simulations, is this a thing?

I never used it either

we can probably remove that sentence

ok, then maybe I'll leave it at a honorable mention of the package instead of providing a working code example.

src/AutoViz.jl

mattuntergassmair · 2020-03-10T11:42:51Z

src/render_instructions.jl

@@ -227,7 +227,8 @@ function render_round_rect(

    if fstroke
        set_source_rgba(ctx, color_stroke)
-        line_width = abs(user_to_device_distance!(ctx, [line_width,0.0])[1])
+        # from Cairo.user_to_device_distance! - this may be the bug
+        # line_width = abs(user_to_device_distance!(ctx, [line_width,0.0])[1])
        set_line_width(ctx, line_width)


Cairo.user_to_device_distance may being used incorrectly here (line_width seems to vary based on heading angle of the vehicle). To be investigated further.

Yes it is not clear to me why we need this function.
I am not sure I understand what it does though: https://www.cairographics.org/manual/cairo-Transformations.html#cairo-user-to-device-distance

I think that typically the line_width does not scale with the zoom level, so it becomes relatively "thinner" as one zooms in. And the user_to_device_distance is used to compensate for that, but maybe there's a bug. I'll open a separate issue so we can take care of it separately.

src/renderable.jl

mattuntergassmair · 2020-03-10T12:10:19Z

docs/src/examples/basics.md

+
+models = Dict((i => Tim2DDriver(timestep) for i in 1:3))  # car models
+# TODO: use a different model for pedestrian
+models[42] = Tim2DDriver(timestep)  # pedestrian model


what is a good pedestrian model to use here?

I would use StaticDriver to keep it simple

MaximeBouton · 2020-03-10T16:59:22Z

Thanks for doing this, two main comments:

1 - Are you re designing brand new tutorials? I had made a notebook for AutoViz 0.8 that you can take inspiration from
2 - the notebook was used in the tests, it would be nice to have all the examples run in the test suite. I don't think there is a nice way to do it though. Maybe the easiest is to just convert some of the examples into proper tests.

mattuntergassmair · 2020-03-10T18:02:34Z

Thanks for doing this, two main comments:

1 - Are you re designing brand new tutorials? I had made a notebook for AutoViz 0.8 that you can take inspiration from
2 - the notebook was used in the tests, it would be nice to have all the examples run in the test suite. I don't think there is a nice way to do it though. Maybe the easiest is to just convert some of the examples into proper tests.

The examples are heavily inspired by the notebooks that were there in the notebooks folder (in fact, I exported them first and used them as a basis to start from). I tried not to lose any information, but felt that it made sense to restructure the examples significantly and focus on different aspects in different tutorials. For example, the camera tutorial now shows all the available cameras, and finally implements a custom camera. I just had a look at the notebook you mentioned, for some reason it wasn't there on the branch that I forked from. I'll make sure to integrate all the information from there in the docs (section on overlays is still work in progress)

mattuntergassmair · 2020-03-10T18:07:11Z

Thanks for doing this, two main comments:

1 - Are you re designing brand new tutorials? I had made a notebook for AutoViz 0.8 that you can take inspiration from
2 - the notebook was used in the tests, it would be nice to have all the examples run in the test suite. I don't think there is a nice way to do it though. Maybe the easiest is to just convert some of the examples into proper tests.

As for testing, how does it work at the moment? Is the documentation built automatically when we push changes? Could we make it fail when there are errors in @examples (currently only warnings). Or is there a way to convert *.md files to *.jl files programatically, such that we could use them for tests?

If none of the above works we should consider writing tests separately but I'm afraid there may be code duplication - would be nice if we could avoid that with one of the aforementioned options.

MaximeBouton · 2020-03-10T18:11:53Z

Yes it is only warnings for now.
With the notebooks, the test suite was including the notebooks and running them so if there was a bug in the notebook it would break the test. Another extra is that it would reflect in the code coverage.
Maybe we can ask on the documenter repo if there is a way to include the examples in the tests.

MaximeBouton · 2020-03-17T05:55:29Z

This is super neat!! thanks a lot

MaximeBouton · 2020-03-19T00:54:21Z

Is this ready to merge? thanks for the work!

Matthias Untergassmair added 5 commits March 9, 2020 18:24

camera tutorial

3d89379

default color always based on id hash

e2593f3

basic tutorial

2276767

added instructions for interact

cf4c8de

minor fixes in docs

cdb8729

mattuntergassmair commented Mar 10, 2020

View reviewed changes

Matthias Untergassmair added 2 commits March 10, 2020 20:32

moved id_to_color

34c3419

tutorials literate

06c070c

Matthias Untergassmair added 3 commits March 17, 2020 15:24

literate scripts in tests

a71c1ff

notebook removed

c6188fb

tests fixed

d37c011

mattuntergassmair merged commit dc84cf3 into sisl:master Mar 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs examples #46

Docs examples #46

mattuntergassmair commented Mar 10, 2020 •

edited

coveralls commented Mar 10, 2020 •

edited

mattuntergassmair Mar 10, 2020

MaximeBouton Mar 10, 2020

MaximeBouton Mar 10, 2020

mattuntergassmair Mar 10, 2020

mattuntergassmair Mar 10, 2020

MaximeBouton Mar 10, 2020

mattuntergassmair Mar 10, 2020

mattuntergassmair Mar 10, 2020

MaximeBouton Mar 10, 2020

MaximeBouton commented Mar 10, 2020

mattuntergassmair commented Mar 10, 2020

mattuntergassmair commented Mar 10, 2020

MaximeBouton commented Mar 10, 2020

MaximeBouton commented Mar 17, 2020

MaximeBouton commented Mar 19, 2020


		You can use Reactive to have them endlessly drive in real time in your browser.

		### TODO: is this a thing? If yes, provide snippet

Docs examples #46

Docs examples #46

Conversation

mattuntergassmair commented Mar 10, 2020 • edited

coveralls commented Mar 10, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MaximeBouton commented Mar 10, 2020

mattuntergassmair commented Mar 10, 2020

mattuntergassmair commented Mar 10, 2020

MaximeBouton commented Mar 10, 2020

MaximeBouton commented Mar 17, 2020

MaximeBouton commented Mar 19, 2020

mattuntergassmair commented Mar 10, 2020 •

edited

coveralls commented Mar 10, 2020 •

edited