memilio icon indicating copy to clipboard operation
memilio copied to clipboard

change wording: replace abm migration by mobility and epi by mio

Open xsaschako opened this issue 1 year ago • 3 comments

Provide a description of requested documentation changes.

Change all occurrences from migration to movement.

xsaschako avatar Nov 24 '23 09:11 xsaschako

I'll probably also rename epi to mio while i'm at it

xsaschako avatar Dec 21 '23 14:12 xsaschako

There are several phrases to change and we need to decide if we want to rename it into mobility or movement, e.g.:

  • Person::migrate_to
  • migration
  • MigrationEdge
  • make_migration_sim
  • time step of migration, daily migration every second step
  • migration data
  • migration_destination
  • use_migration_rules
  • apply_migration
  • forward migration

xsaschako avatar Dec 22 '23 10:12 xsaschako

We decided on:

  • mobility if not a verb
  • go (to) as a verb (comment functions with “mobility” keyword)

xsaschako avatar Jan 02 '24 09:01 xsaschako

We decided on:

  • mobility if not a verb
  • go (to) as a verb (comment functions with “mobility” keyword)

For now, I renamed everything to "movement" or "move_to". Didn't read this comment before doing so. I can redo it and call it mobility. Perhaps we decide on this quickly.

DavidKerkmann avatar Jul 03 '24 21:07 DavidKerkmann

Since there were still some unclear points and no perfect naming, we discussed in a group an propose:

  • "mobility" if not a verb
  • "commuted" for the "migrated" vector in the graph-ode parts (MobilityEdge)
  • "change_location" for the ABM function to change a single persons location
  • "perform_mobility" for the large ABM function that handles all the mobility

@mknaranja Do you agree with this?

DavidKerkmann avatar Jul 08 '24 13:07 DavidKerkmann

Instead of "commuted", we use "mobile_population".

DavidKerkmann avatar Jul 19 '24 08:07 DavidKerkmann

There are many appearances of "moved" or "move" that were previously "migrated" or "migrate" which relate to a verb, in particular in memilio/cpp/memilio/mobility/metapopulation_mobility_instant.h. We need to have a verb for these, if we use "mobile_population" as a noun.

DavidKerkmann avatar Jul 20 '24 11:07 DavidKerkmann

We only need verbs for the documentation right? Because the parameters "migrated", "return_migrated" etc. will be renamed to "mobile_population", "return_mobile_population". For the documentation verbs could be "change location" in the ABM and "change node" in the Graph model.

jubicker avatar Jul 23 '24 08:07 jubicker