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

AguaClara-specific python tutorial #37

Open
juanchon998 opened this issue Aug 8, 2018 · 4 comments
Open

AguaClara-specific python tutorial #37

juanchon998 opened this issue Aug 8, 2018 · 4 comments
Labels
addition New tutorial section high priority Heavily affects many users

Comments

@juanchon998
Copy link
Member

I am working on finding/consolidating a tutorial for python that can be used for the textbook. It should include all the AguaClara specific python uses , including

  • units
  • graphing
  • aide functions

It doesn't seem like what I am looking for exists on this repo, which is where I would expect to find it. The best thing I could find is the CEE 4540 Python tutorial, which is currently a Jupyter notebook, attached. It is quite comprehensive.

I would like to convert this file to markdown and include the first section (not including any of the actual problems/questions) in this repo's wiki. I will also put the actual assignment problems/solutions somewhere, but I am not sure where it makes the most sense to do so. @oliver-leung what do you think of this idea, and do you have any recommendations as to where the assignment portion should go?

@oliver-leung
Copy link
Contributor

@juanchon998 Sorry for the late reply! Could you send a link to the Jupyter notebook?

I'm right now writing a simple Python Tutorial in the aguaclara_tutorial wiki, with accompanying interactive tutorial assignments in the aguaclara_tutorial repo itself. After I have a look at the CEE 4540 Python tutorial, we can decide whether we should

  1. Keep it separate from the aguaclara_tutorial wiki's Python tutorial, or
  2. Combine the tutorials and keep separate copies in both the aguaclara_tutorial wiki and the Textbook.

I think that, although it would be a bit difficult to make changes, we shouldn't link between the aguaclara_tutorial wiki and the Textbook to avoid any confusion that could arise when a non-4540 AguaClarian goes into the Textbook, or vice versa.

@oliver-leung oliver-leung added high priority Heavily affects many users addition New tutorial section labels Aug 15, 2018
@juanchon998
Copy link
Member Author

juanchon998 commented Aug 16, 2018

I think a lot of the content in this tutorial is definitely worth keeping in a new AguaClara tutorial. I tried to open the tutorial in https://mybinder.org/ by launching the repo it's in, but I'm running into problems. I believe it's because the repo is private (it's Monroe's 4540 solution repo). I've attached the zipped .ipynb file.

To be honest I'm not sure what the best way to do this would be. Having two separate versions of the same tutorial seems cumbersome to me, I would vote for linking one tutorial in the other document (wiki, textbook) and carefully explaining what is being done. But that's just me!

DC_Python_Tutorial_2_Solution.zip

Edit: Just kidding I remembered how I had previously opened the file online. Here is the link to the mybinder.org version of the file.

@oliver-leung
Copy link
Contributor

oliver-leung commented Aug 17, 2018

The link is broken, with the message:

A shareable Binder link should look like https://mybinder.org/v2/gh/...

Do you have a link like that?

Edit 1: Also, if you'd like to see what I've made so far for the interactive tutorials, checkout the add-tutorials of this repo - they start with Lesson 1, Lesson 2, etc. and follow along with the wiki tutorials up to the Writing Python Code section.

Edit 2: I managed to get the Jupyter Notebook to work - that's quite a nice tutorial!

On second thought, I do agree that we should keep it in one location, which should probably be this wiki/repo. Whoever is using the tutorial will have to download an accompanying, separate interactive tutorial since we're no longer using Jupyter. AguaClarians will already have cloned the interactive tutorials at this point in the tutorials, and 4540 students will need to download it anyways. Thoughts on that?

@juanchon998
Copy link
Member Author

juanchon998 commented Aug 17, 2018

I think that having just one tutorial document makes the most sense, and having it be on this repo is the most logical choice. I'll definitely check out the tutorial, probably in the next few days!

Edit 1: Sorry for the broken link, but I'm glad you managed to get it to work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addition New tutorial section high priority Heavily affects many users
Projects
None yet
Development

No branches or pull requests

2 participants