JuliaDynamics/Agents.jl

Move `add/remove_agent_from_space!` to the public API

Open

#1,154 opened on Apr 8, 2025

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Julia (904 stars) (146 forks)batch import
good first issuespace interaction api

Description

Following from the discussion here: https://discourse.julialang.org/t/remove-agent-from-space-but-not-scheduler/127842/10

The summary is: there are good reasons for users to be able to directly add or remove agents to a space, without removing them from existence (the ABM itself) alltogether.

To do this we need to make the add/remove_agent_from_space! public, and also:

  • In its docstring document that this function is already called internally in add_agent! or remove_agent! and therefore does nto have to be manually called by the user if they are doing this operation.
  • Test EXTENSIVELY in ALL SPACES whether using these functions directly without add/remove_agent! leads to any breakages.

This feature is a pre-requisitive step for #910 .

Contributor guide

Tech stack
None
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Agents.jl library usageJulia language fundamentalsUnderstanding of space types
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The task involves making `add agent from space!` and `remove agent from space!` public by exporting them and adding documentation. The docstring should clarify that these are called internally. Testing should be performed across all space implementations, likely in `test/` directory. Refer to issue #910 for the follow up feature. The discourse discussion provides context for the design decision.
Move `add/remove_agent_from_space!` to the public API · JuliaDynamics/Agents.jl#1154 | Good First Issue