ericmjl/Network-Analysis-Made-Simple

ebook-style

Closed this issue · 8 comments

I'd like to upgrade the repository a bit here, and make it into a format that is simultaneously compatible with:

  • Running a tutorial
  • Publishing an online book
  • Exporting as a collection of PDFs to be printed.

This will be done in a branch. I'll be running some experiments on my personal static site server to see how this can be done most effectively.

@MridulS check this out!

Still in the early stages, but the rewrite is ongoing.

Yes, let's definitely get that in.

There's a pattern I've started using in there.

We can dispense with instructor/student dichotomy if we:

  • Put solutions in the nams.solutions subpackage as functions which we then import back.
  • This allows us to use code that looks like:
from nams.solutions.ch1 import adding_students

#### REPLACE THE NEXT LINE WITH YOUR ANSWER
G = adding_students(G)

Doing so thus allows us to:

  1. Execute the notebook in its entirety during build time.
  2. Keep the answers obscured from students, thus letting us maintain instead a single source of truth for the text.
  3. Reveal answers right at the bottom of each notebook (like a book).

This gives us the versatility to use the notebooks both as a book and as a tutorial thing. The final thing I have to figure out is how to get the Docker build to be compatible with both running a Dokku web server and a Jupyter server on Binder. Once that is done, we'll have a triple-use eBook/tutorial notebook. It'll be amazing!

@MridulS I think we're almost ready to merge in the latest changes! If I'm looking correctly, I think the Airport Network chapter is the last one left. No pressure, though. If you feel like you need more time, I'm OK with hiding it from the navigation until you PR it in. What do you think?

Stay safe out there!

Okie dokes, sounds good to me.

Btw, do you have a LeanPub account? Let’s publish Network Analysis Made Simple together as a proper e-Book up there.

Closing this out, since we've crossed the book over the line! Thanks for all the effort in making the case studies, @MridulS!