-
Notifications
You must be signed in to change notification settings - Fork 27
Docs/tutorial solutions/exercises #736
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
Conversation
…al, including Exercises
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. |
docs/advanced_installation.rst
Outdated
--- | ||
|
||
We always recommend installing in a virtual environment such as Conda. | ||
If not, then use ``pip3``, ``python3`` below. |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?"
There was a problem hiding this comment.
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!') | ||
There was a problem hiding this comment.
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?
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...." |
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) |
Open to views but we may want to standardise the H argument coming in and the out as H_in and H_out maybe? |
Optional: |
There was a problem hiding this 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.
experimenting with adding drop-down boxes for tutorial exercises/solutions