Skip to content

Conversation

jlnav
Copy link
Member

@jlnav jlnav commented Feb 15, 2022

experimenting with adding drop-down boxes for tutorial exercises/solutions

@jlnav jlnav requested a review from shuds13 February 24, 2022 19:04
@jlnav jlnav marked this pull request as ready for review February 24, 2022 19:04
@jlnav jlnav requested a review from jmlarson1 February 24, 2022 19:04
@jlnav jlnav changed the title [WIP] Docs/tutorial solutions/exercises Docs/tutorial solutions/exercises Feb 24, 2022
@jlnav
Copy link
Member Author

jlnav commented Feb 24, 2022

Decided to leave exercises for only the first two tutorials for now, since the last two tutorials don't especially involve writing functions, only demonstrating capabilities

edit: modifying parameters or settings is covered in earlier tutorials, but doing that (or just saying to read the example regression tests) is all I can imagine for the last two tutorials.

---

We always recommend installing in a virtual environment such as Conda.
If not, then use ``pip3``, ``python3`` below.
Copy link
Member

Choose a reason for hiding this comment

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

I'm okay with python/pip without the 3. But we should be consistent. Later python3 is used in a couple of places (when running the calling script). We should decide generally for the docs whether we want to drop the 3.


Write a Calling Script with the following specifications:

1. Use the Exercise simulator and generator functions instead
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps have this above the enumerated part?

Copy link
Member Author

Choose a reason for hiding this comment

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

As in, list everything, then say: "Write a Calling Script with the above specifications?"

Copy link
Member

Choose a reason for hiding this comment

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

I misinterpreted this line as saying instead do the following lines. Perhaps say something like use the functions from the answers to the exercises.

if flag != 0:
print('Oh no! An error occurred!')
Copy link
Member

Choose a reason for hiding this comment

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

What do people think about introducing parse_args here somewhere?

@shuds13
Copy link
Member

shuds13 commented Mar 7, 2022

Checking here - I think somewhere the tutorials should have a link/location where to find example in the repo. Maybe at bottom of first section. "This example can be found in the repository at...."

@jlnav jlnav requested a review from shuds13 March 7, 2022 19:46
@jlnav
Copy link
Member Author

jlnav commented Mar 8, 2022

Links to example python files and a parse_args item for exercises added. Once this is pulled in I'll work on updating the jupyter notebooks

(branched off and starting work, actually)

@shuds13
Copy link
Member

shuds13 commented Mar 9, 2022

Open to views but we may want to standardise the H argument coming in and the out as H_in and H_out maybe?

@shuds13
Copy link
Member

shuds13 commented Mar 9, 2022

Optional:
"Our simulator function is called by a worker for every value in its batch from the generator function." could maybe be
"Our simulator function is called by a worker for every work item produced by the generator function"

Copy link
Member

@shuds13 shuds13 left a comment

Choose a reason for hiding this comment

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

I made a few comments. All optional.

@jlnav jlnav merged commit c890da9 into develop Mar 9, 2022
@jlnav jlnav deleted the docs/tutorial_solutions branch March 9, 2022 18:49
@shuds13 shuds13 mentioned this pull request Mar 15, 2022
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants