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

Convert markdown tutorial to jupyter tutorial #101 #135

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

reyan-singh
Copy link
Contributor

Converted the introductory tutorial (/mesa-frames/docs/general/user-guide) from Markdown to Jupyter format, Please Review and let me know if any other files to be converted

Now code is able to run and execute in the tutorial itself and in case of success/error it is able to show the output

NOTE: I tried to run the code and all the cells above the "Running the code" cell were able to run on tutorial itself but I found when I tried to run the "Running the code" cell it gives an error, good part is I am able to see the output(error) there itself

so looks like Example code has a few error and may need fixes , would you like to create a new issue to fix the Tutorial code.

Inital commit to convert exisitng tutorial format from md to jupyter tutorial
Copy link

codecov bot commented Mar 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@a097949). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #135   +/-   ##
=======================================
  Coverage        ?   91.29%           
=======================================
  Files           ?       14           
  Lines           ?     2217           
  Branches        ?        0           
=======================================
  Hits            ?     2024           
  Misses          ?      193           
  Partials        ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@adamamer20
Copy link
Member

try building the documentation to see if it gives a correct output. in case of errors, make the necessary adjustments

Error is fixed for tutorial "Running the model" cell, which used to display distribution stats
@reyan-singh
Copy link
Contributor Author

try building the documentation to see if it gives a correct output. in case of errors, make the necessary adjustments

@adamamer20 "running the model" cell tutorial example is fixed, looking into performance comparison

Updated Performance comparison code for support for jupyter based markdown page
@reyan-singh
Copy link
Contributor Author

@adamamer20 updated the tutorial page along with running code, please review and suggest if missing anything

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.

2 participants