mesa icon indicating copy to clipboard operation
mesa copied to clipboard

Move experimental DEVS examples to mesa-examples

Open EwoutH opened this issue 1 year ago • 7 comments

The examples in https://github.com/projectmesa/mesa/tree/main/mesa/experimental/devs/examples should be moved to mesa-examples, and tested in CI there.

Or at least tested in CI.

Like all our examples, the code should be exemplary and clearly documented. The code part is already good, but a visualisation (app.py) using Solara and Readme should be added.

So for each model:

  • Create new, separate folder with _experimental_devs suffix.
  • Put the model and agent code in agent.py and model.py
  • Create an app.py file in which SolaraViz is used (see https://github.com/projectmesa/mesa-examples/issues/154)
  • Create/update the Readme to describe how the experimental features are used (including DEVS, see https://github.com/projectmesa/mesa-examples/issues/124)

EwoutH avatar Aug 02 '24 10:08 EwoutH

Please assign this issue to me @EwoutH I will work on this

VinayakPaka avatar Aug 04 '24 19:08 VinayakPaka

Awesome! Also check out this issue, for some more resources:

  • https://github.com/projectmesa/mesa-examples/issues/124

EwoutH avatar Aug 04 '24 19:08 EwoutH

@EwoutH hey can you explain me this issue ,it is confusing

VinayakPaka avatar Aug 04 '24 19:08 VinayakPaka

We have two repo’s: Mesa for our core project and Mesa-examples for examples using that project.

The examples linked above are now in our main Mesa repo (and are a bit outdated), and need to be moved to Mesa-examples.

Also, since our Discrete Event Scheduling functionality is quite new, we like more examples using it in general.

Does this help?

EwoutH avatar Aug 04 '24 19:08 EwoutH

Yeah, That's Great Information and I will complete this soon.

VinayakPaka avatar Aug 04 '24 19:08 VinayakPaka

Hi @EwoutH, I would like to work on this issue. Could you please assign it to me?

RaisunLakra avatar Oct 11 '24 11:10 RaisunLakra

@RaisunLakra thanks for the interest! With the discussion about the monorepo kicking in, I like to put this on hold for a while:

  • https://github.com/projectmesa/mesa/discussions/2330

If you want to work on Mesa, we could use a lof of help with updating our examples! See these issues and this part of our contribution guide.

EwoutH avatar Oct 11 '24 11:10 EwoutH