📚 API Documentation

Create the school population for this simulation using its latest SimulationConfig.

Behavior:
- Uses the most recent SimulationConfig linked to this Simulation (by id desc).
- Clears existing schools for this simulation before creation.
- Generates `number_of_schools` schools named "School {i}" with scores drawn from a
  beta distribution using school_score_mean and school_score_stddev, ensuring scores stay between 0-1.
  Capacities use Gaussian distribution. Capacity is coerced to an int >= 0.
- Uses school_meta_scores_stddev from config when generating score_meta values based on
  config.applicant_meta_preference: each meta gets beta-distributed scores with base_score as mean.
- Also generates meta_preference weights per school using config.school_meta_preference and
  config.school_meta_preference_stddev, storing the stddev into meta_stddev_preference.
- Returns the number of schools created.

Create the student population for this simulation using its latest SimulationConfig.

Behavior:
- Uses the most recent SimulationConfig linked to this Simulation (by id desc).
- Clears existing students for this simulation before creation.
- Generates `number_of_applicants` students named "Student {i}" with scores drawn from a
  beta distribution using applicants_score_mean and applicant_score_stddev, ensuring scores stay between 0-1.
- Uses applicant_meta_scores_stddev from config when generating score_meta values based on
  config.school_meta_preference: each meta gets beta-distributed scores with base_score as mean.
- Also generates meta_preference weights per student using config.applicant_meta_preference and
  config.applicant_meta_preference_stddev, storing the stddev into meta_stddev_preference.
- Returns the number of students created.

Delete the school population for this simulation.

Delete the student population for this simulation.

Upload schools from a CSV file located in BASE_DIR/data.

Expected CSV format (with header): name,capacity,score[,score_meta]
- score_meta: JSON object string mapping meta names to values.
File path convention: data/simulation_{self.id}_schools.csv
- Replaces existing schools for this simulation.
- Returns the number of schools created. Returns 0 if the file does not exist.

Upload students from a CSV file located in BASE_DIR/data.

Expected CSV format (with header): name,score[,score_meta]
- score_meta: JSON object string mapping meta names to values.
File path convention: data/simulation_{self.id}_students.csv
- Replaces existing students for this simulation.
- Returns the number of students created. Returns 0 if the file does not exist.

See check_password().

See get_group_permissions()

See get_user_permissions()

See has_module_perms()

See has_perm()

See has_perms()

Return a boolean of whether the raw_password was correct. Handles
hashing formats behind the scenes.

Send an email to this user.

Return the first_name plus the last_name, with a space in between.

Return a list of permission strings that this user has through their
groups. Query all available auth backends. If an object is passed in,
return only permissions matching this object.

Return an HMAC of the password field.

Return the short name for the user.

Return a list of permission strings that this user has directly.
Query all available auth backends. If an object is passed in,
return only permissions matching this object.

Return the username for this User.

Return True if the user has any permissions in the given app label.
Use similar logic as has_perm(), above.

Return True if the user has the specified permission. Query all
available auth backends, but return immediately if any backend returns
True. Thus, a user who has permission from a single auth backend is
assumed to have permission in general. If an object is provided, check
permissions for that object.

Return True if the user has each of the specified permissions. If
object is passed, check if the user has all required perms for it.

Return False if set_unusable_password() has been called for this user.