Create an example notebook to show users how to use the pipeline

UCL / ioe-student-school-allocation

Public release of the code for paper 846 of AGILE2023

BSD 3-Clause "New" or "Revised" License

4 stars 2 forks source link

Create an example notebook to show users how to use the pipeline #17

Closed paddyroddy closed 1 year ago

paddyroddy commented 1 year ago

PR authored by @nickbearman, but I'm making a draft PR because I have merged #16 and want to make sure I know what is being changed here.

review-notebook-app[bot] commented 1 year ago

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

paddyroddy commented 1 year ago

Two main thoughts @nickbearman.

Should we be committing the .mps file? I don't know what it does.
Can you re-create the journeys/failures files now that I've updated the main. Probably including car etc in too.

paddyroddy commented 1 year ago

Also the map now renders in the notebook

nickbearman commented 1 year ago

Two main thoughts @nickbearman.

Should we be committing the .mps file? I don't know what it does.

I think this is created when the model is run. Given we also now have a CSV output, I think we can treat this as a temporary file and ignore it.

Can you re-create the journeys/failures files now that I've updated the main. Probably including car etc in too.

Yes I think so

paddyroddy commented 1 year ago

I disagree about the .mps file unless it is much slower without it. I will investigate. In general, we should only have stuff in a repo that is essential.