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.

Sign up for GitHub

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

Jump to bottom

Tutorial improvement #1717

Closed
wants to merge 6 commits into from
Closed

Tutorial improvement #1717

wants to merge 6 commits into from

Conversation

rht
Copy link
Contributor

@rht rht commented Jun 17, 2023

No description provided.

EwoutH and others added 6 commits March 28, 2023 23:17
@EwoutH
docs: Update the intro tutorial
77d1381 
Update the intro tutorial. Use Seaborn for more flexible and easier to read and manipulate plots. Add parts about analysing agent reporters and showing some different kinds of plots.

- Also make seaborn a required dependency
- Also let the DataCollector save index name(s) for the DataFrames returned. This enables not manually having to label the x-axis each time when the time step is used on the x-axis, and improved unstacking.
@EwoutH
Update install link in tutorial and update DataCollector
ac24f5e 
- Update the dependency installation link in the tutorial to https://github.com/projectmesa/mesa-examples/blob/main/examples/boltzmann_wealth_model_network/requirements.txt
- Update the DataCollector to remove redundant changes (adding index names and the to_dict().
@rht
Clear output
a4529f5
@rht
docs: Use nbsphinx on adv_tutorial
0a671b2
@rht
fix: Restrict Sphinx to be <7
597ba4e 
See readthedocs/readthedocs.org#10279
@rht
Remove metadata
9e385be
@rht rht mentioned this pull request Jun 17, 2023
Closed
@codecov
Copy link

codecov bot commented Jun 17, 2023 •
edited
Loading

Codecov Report

❗ No coverage uploaded for pull request base (target-for-pr-1625@cebdb87). Click here to learn what that means.
Patch has no changes to coverable lines.

Additional details and impacted files 
@@                  Coverage Diff                  @@
##             target-for-pr-1625    #1717   +/-   ##
=====================================================
  Coverage                      ?   81.84%           
=====================================================
  Files                         ?       18           
  Lines                         ?     1388           
  Branches                      ?      271           
=====================================================
  Hits                          ?     1136           
  Misses                        ?      206           
  Partials                      ?       46

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@rht
Copy link
Contributor Author

rht commented Jun 17, 2023 •
edited
Loading

I'm progressively creating multiple PRs for this:

Sections to be ported:

  • "You can also plot a reporter of multiple agents over time."
  • "Read the model data from the CSV file"
  • "Additional agent reporter"
  • "We can create differnt kinds of plot from"
  • "Analyzing model reporters: Comparing 5 scenarios"
  • "Analyzing agent reporters"
  • "Calculate the mean of the wealth"

@tpike3 tpike3 added this to the Mesa 2.0 milestone Jun 18, 2023
@tpike3
Copy link
Member

tpike3 commented Jun 18, 2023

I'm progressively creating multiple PRs for this:

Sections to be ported:

  • "You can also plot a reporter of multiple agents over time."
  • "Read the model data from the CSV file"
  • "Additional agent reporter"
  • "We can create differnt kinds of plot from"
  • "Analyzing model reporters: Comparing 5 scenarios"
  • "Analyzing agent reporters"
  • "Calculate the mean of the wealth"

I am tracking you are still working some of these, so it is not yet ready. Is that correct?

@rht
Copy link
Contributor Author

rht commented Jun 18, 2023

Yes, I haven't worked on them yet.

@tpike3
Copy link
Member

tpike3 commented Jun 24, 2023

@rht --

  • Do you want this to be part of 2.0?
  • If yes, do you want co-authors to help knock out some of the tasks or no?

@rht
Copy link
Contributor Author

rht commented Jun 25, 2023

This is not a blocker to 2.0 / it's optional, given that the blocker ones are the breaking changes ones. But yeah, I'd appreciate if you want to pick up the tasks in the list.

@tpike3 tpike3 modified the milestones: Mesa 2.0, ReadtheDocs Jun 25, 2023
rht added a commit to rht/mesa that referenced this pull request Oct 15, 2023
@rht
intro tutorial: Explain how to plot reporter of multiple agents
3ae782a 
This is a section taken from projectmesa#1717.
@rht rht mentioned this pull request Oct 15, 2023
Merged
rht added a commit to rht/mesa that referenced this pull request Oct 15, 2023
@rht @EwoutH
intro tutorial: Explain how to plot reporter of multiple agents
7b05d4e 
This is a section taken from projectmesa#1717.

Co-authored-by: Ewout ter Hoeven <[email protected]>
tpike3 pushed a commit that referenced this pull request Oct 16, 2023
@rht @EwoutH @tpike3
intro tutorial: Explain how to plot reporter of multiple agents
d40bc5b 
This is a section taken from #1717.

Co-authored-by: Ewout ter Hoeven <[email protected]>
@EwoutH
Copy link
Member

EwoutH commented Dec 22, 2023

What are we going to do with this PR? I think it's nice to get some tutorial improvements in 2.2.0.

@EwoutH EwoutH mentioned this pull request Dec 22, 2023
Closed
@EwoutH
Copy link
Member

EwoutH commented Jan 16, 2024

With #1955 merged, I think we can close this right?

@rht
Copy link
Contributor Author

rht commented Jan 16, 2024

Does #1955 contain everything in this PR? It was so much easier to review with the smaller diff and the RTD.

@rht rht closed this Jan 17, 2024
@rht rht deleted the tutorial_improvement branch January 17, 2024 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
ReadtheDocs
Development

Successfully merging this pull request may close these issues.
3 participants
@rht @tpike3 @EwoutH