This pull request introduces policy on how to structure a behavior.
Motivation
When developing and machine-generating behaviors, I lacked a lot of detail what should be in them where and in what form. Therefore I tried to formalize that.
Mixin
The most important decision in this document is that a Mixin paradigm is used to get behaviors in existing Agents. This allows very easy integration in existing agent.
If the behavior is stateless, we make an exception, and then it's a regular Python function.
Other
There is also a general readme file and a definitions file with some definitions currently used.
Any feedback, discussion and feedback on these policies is very welcome!
This might close both #3 and #4, but I'm leaving them both open until I'm actually happy with them.
Summary by CodeRabbit
Documentation
Introduced a new section in the README outlining development policies for the world model, including a call for contributions.
Added a "Definitions" policy document clarifying key terms used in the repository.
Created a "Behavior Structure" policy document providing guidelines for designing and structuring behaviors and functions in Agent-Based Modeling.
This pull request introduces policy on how to structure a behavior.
Motivation
When developing and machine-generating behaviors, I lacked a lot of detail what should be in them where and in what form. Therefore I tried to formalize that.
Mixin
The most important decision in this document is that a Mixin paradigm is used to get behaviors in existing Agents. This allows very easy integration in existing agent.
If the behavior is stateless, we make an exception, and then it's a regular Python function.
Other
There is also a general readme file and a definitions file with some definitions currently used.
Any feedback, discussion and feedback on these policies is very welcome!
This might close both #3 and #4, but I'm leaving them both open until I'm actually happy with them.
Summary by CodeRabbit