Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More detailed documentation? #6

Closed
IainNZ opened this issue May 13, 2013 · 5 comments
Closed

More detailed documentation? #6

IainNZ opened this issue May 13, 2013 · 5 comments

Comments

@IainNZ
Copy link
Contributor

IainNZ commented May 13, 2013

This package is pretty great, and I'm kinda figuring out things by looking at the examples and modifying them. Do you think you could write some quick documentation that details the function arguments?

For example, even in example_1.jl its not really clear what the arguments are doing, and a few comments would go a long way, especially for those (like me!) who haven't used these other packages.

@IainNZ
Copy link
Contributor Author

IainNZ commented May 13, 2013

Also, the bank examples are really good and actually more what I was looking for as examples, are they based on examples in another language? I could document them perhaps if it would help.

@BenLauwens
Copy link
Collaborator

Hi
I am aware that documentation is lacking. The last weeks I was doing a first implementation of the continuous simulation part. The new development ideas are outrunning the documentation support;)
The examples of the bank are a translation of the bank tutorial of SimPy: http://simpy.sourceforge.net/SimPy_Manual/SimPy_Tutorials.html
I would really appreciate your help. So be free to clone the repository, start documenting or providing more examples (the bank tutorial has a lot of other examples and there is also a second part!) and do a pull request.
This week I am not at the office so my response can take a little longer but whatever problem you encounter, I will try to answer as fast as possible.
Ben

@IainNZ
Copy link
Contributor Author

IainNZ commented May 14, 2013

Cool, will try to do something.
One thing: what is the meaning of the first argument to Simulation?

@BenLauwens
Copy link
Collaborator

The number of tasks that can be run simultaneously, i.e. the number of events that can be stored in the event heap.
Perhaps I can provide a constructor without this parameter...

@IainNZ
Copy link
Contributor Author

IainNZ commented May 15, 2013

Ah that makes sense, I had a heap error and increasing that fixed it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants