search

JuliaDynamics / DiscreteEvents.jl

Discrete event generation and simulation in Julia
MIT License
56 stars 10 forks source link

Rename package #13

Closed pbayer closed 4 years ago

pbayer commented 4 years ago

As @John_Gibson pointed out it would be appropriate to rename the package. I like his suggestion to name it DiscreteEvent.jl.

non-Jedi commented 4 years ago

I think that the word "simulate" is more important to the package's identity than "discrete" since "discrete" is already implied by "event". Personally, I would go for something like "EventSim".

pbayer commented 4 years ago

In the long term we need a domain-specific ecosystem in Julia for simulation like BioJulia, JuliaOpt, EcoJulia, JuliaStats. Currently we have three packages for discrete event simulation 😒, each with Sim in the name. At the moment it makes sense to keep them separate from an evolutionary perspective.

There is no JuliaSim yet and SimJulia.jl is another package. This commends for the time being to keep the Sim in the package name as you suggest.

pbayer commented 4 years ago

EventSim.jl is a name perhaps too close to EventSimulation.jl, one of the other two packages. SimEvent.jlwould be another option but sounds a bit like MathWorks SimEvents. 😕

vancleve commented 4 years ago

seems like SimulateEvents.jl is a natural option :-)

non-Jedi commented 4 years ago

I also like DiscreteSim.jl as a clear and unencumbered option.

pbayer commented 4 years ago

Here's a word play:

swissr commented 4 years ago

I'm just reading up. -- I like DESim.jl because it fits well into the wikipedia articles (sorry german) DES and Discrete Simulation. I also like the first proposition DiscreteEvent.jl; within a Simulation ecosystem domain it specifies what the package is about.

From the first wikipedia link I'm not sure about DiscreteSim.jl, it seemed to me that this term is more generic than discrete event simulation.

pbayer commented 4 years ago

DESimulate.jl would maintain the connection with the current package name. I still also like DiscreteEvent.jl, but can we bet that a Julia simulation ecosystem will emerge? It should!

non-Jedi commented 4 years ago

This is becoming a pretty bad "bikeshed", so this will probably be my last response.

I'd strongly recommend avoiding abbreviations and acronyms that are not well-known to the general population ("Sim" is well-known to be shorthand for "Simulation", but "Ev" isn't for "Event" nor "DES" for "Discrete Event Simulation" outside of a tiny segment of the population). In fact the manual for Pkg.jl has a section recommending against this. I'm not super invested in which specific package name is picked, but I would strongly prefer it not have an inscrutable abbreviation in it.

Of the suggestions shared so far, I've come to like DiscreteEvent (I think DiscreteEvents is slightly less awkward, but that's a whole 'nother bikeshed) or SimulateEvents best the more I think about it. They are relatively long, but they're clear on the package's purpose, and you only have to type using SimulateEvents once.

EDIT: after reviewing the naming guidelines again, this definitely falls under point 5. So you could consider something more creative here and less descriptive:

pbayer commented 4 years ago

Thank you for pointing out the guidelines regarding abbreviations and also for the funny suggestions 😆. Yes, DiscreteEvents.jl and SimulateEvents.jl are both fine.

pbayer commented 4 years ago

Simulate.jl has been renamed to DiscreteEvents.jl and successfully built on CI. GitHub maintains the old links and redirects them to the renamed package.

ga72kud commented 2 years ago

@pbayer what is the actual package simulate or discreteEvents? What will be supported? The Simulate.jl documentation does not work...