Project Meeting 2023.11.28 - ActivitySim/activitysim GitHub Wiki

Agenda

  • Admin
    • Partner’s Only Meeting (11/30)
  • User Guide Update (CS)

Meeting Notes

User's Guide Update (CS)

  • Users Guide — ActivitySim (camsys.github.io)
  • Bulk of work spent organizing, altering framework, and utilizing content which already exists, while limiting new content.
  • Background
    • Major sections on left of screen. Headings of sections on the right. This gives the ability to jump back and forth between multiple sections.
    • “Search” function searches documentation. However, this function does not work when in the CamSys fork. When accessing activitysim.github.io, the Search function will sift through current and older versions.
    • Quick Reference Section
      • New
      • This section may be utilized by folks who are particularly technologically savvy and wish to get ActivitySim up and running.
    • Model Setup
      • Testing of installation methods in progress.
    • Ways to Run the Model
    • Anatomy of the Model
      • New section suggested by Joe.
      • Generic. Implementations discussed in “Example Models”/”Other Example Models.”
    • How the System Works
      • Does the diagram/flow chart align with what was pictured? Visualizations already exist which could be tweaked for the purpose of the User’s Guide.
    • Model Development
      • New
      • Input Data Preparation: Nothing found to recycle. Currently a placeholder to be filled in.
      • Calibration: Whoever is selected for this task may add to User’s Guide in the future. In addition, are there any other future tasks that will need adding to the User’s Guide going forward? Roll into budget and technical task.
    • Visualization
      • Broken image links have been fixed.
    • Example Models/Other Example Models
      • This section needs the most work.
      • Which examples desired by the consortium?
      • What is easiest/most convenient to maintain?
  • Overall Thoughts/Comments
    • Potential Section: “Memory Profiling” or “Run Optimization”
      • Better inform on hardware requirements.
    • Model sections and structure make sense and flow sensibly.
    • Rest of budget could be used to improve Installation and Example sections?
    • By all means, refine the Installation section. Based on feedback, allocate remaining resources accordingly.
  • How Best to Provide Feedback
    • Copy/paste URL with desired/recommended edits to be sent via email to Michelle Bina ([email protected]).
    • Set a deadline for comments and suggestions from the consortium.
    • Feedback Deadline: 12/5/2023

Going Forward

  • ActivitySim Consortium Meeting (11/30): Cancelled
  • ActivitySim Consortium Meeting (12/5): Cancelled. Potential User’s Guide feedback discussion.
  • ActivitySim Consortium Meeting (12/7): Cancelled
  • Release schedule: Tentative end of December release (Happy Holidays!)