The Simuleau tool has been developed to provide an academic tool for modeling and simulating systems described by the Petri Nets (PN) formalism, with a specific focus on Batches Petri Nets (BPN) models.
BPN models were initially used to model the Perrier water bottling manufacturing system, in which conveyors were modeled using batch places. Since then, BPN models have been developed and applied in various areas such as high-speed communications, traffic and crowd modeling.
## Getting started
The first version of Simuleau was proposed in 1993 to implement the concepts of the "original" BPN class. In 1998, the concepts of sensors and control were integrated into the tool.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Since 2016, the current version of Simuleau has been under development. The goal of this new version is to rewrite the old code using modern programming languages, integrate the various extensions of BPN that have been developed in recent years, and restructure the tool to make it easier to develop future extensions.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
Simuleau is a tool written in C++ that runs on Linux systems. It enables the modeling and simulation of systems described using Petri Net (PN) formalism, specifically focusing on different classes of Batch Petri Nets (BPN) models. The goal of Simuleau is to provide an academic tool for modeling and simulating BPNs.
## Add your files
##Interface
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
To make the tool user-friendly, we have incorporated a textual menu interface that displays different options to the user. The main menu of Simuleau includes in option "1", which enables the user to compile the input file and verify the model using Simuleau.
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
0) Exit Simuleau (Option 0 always exits the current menu)
````
-[ ] [Set up project integrations](https://gitlab.lis-lab.fr/leonardo.brenner/simuleau/-/settings/integrations)
The option "2" in the main menu leads the user to the simulation menu. In this menu, the user can select from different simulation algorithms. One of the options, option "2", simulates the system's evolution without control (autonomous). The remaining options simulate the system's evolution using external controlled events (option "1") or controlled methods that drive the system's evolution to a steady state.
## Collaborate with your team
````
******* Simulating a BPN model *******
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
1) With controlled events 3) On/Off control method
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
2) Without conntrolled events 4) MF-On/Off control method
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Use the built-in continuous integration in GitLab.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
## Textual model description
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
Another important development in this new version of Simuleau is the input model description. The objectives for this syntax are to have a human-readable input file and to use well-known tools like flex and bison to make the development easy and extendable.
# Editing this README
Here is a brief example of the input syntax used in Simuleau. The Petri net model is described in a textual file, which is structured in three blocks.
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
The first block of the input file gives a name to the model and sets the length and time units.
## Suggestions for a good README
````
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
// double "/" for comments
model example;
## Name
length unity=km;
Choose a self-explaining name for your project.
time unity=h;
````
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
The second block is dedicated to the model description. The keyword "network description" starts this block. The block is organized into two sub-parts. The first one describes the places of the model, while the second one is dedicated to the transitions. Different types of places (discrete, continuous, batch, and triangular) and transitions (discrete, continuous, batch) can be described. Each one has specific parameters, and some are optional.
## Badges
An example of a model description is given below.
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
````
## Visuals
network description
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
places
place DPlace (discrete)
## Installation
initial marking {2} // integer value
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
steady marking {1} // optional parameter
output arc DTransition (2) // 2 is the weight of the arc
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
place CPlace (continuous)
initial marking {2.3} // real value
## Support
steady marking {1.1} // optional parameter
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
output arc CTransition // if no specified weight is 1
## Roadmap
place BPlace (batch)
If you have ideas for releases in the future, it is a good idea to list them in the README.
function (110, 200, 10) // speed, max density, and length
initial marking {(1.2, 150, 9.0)}
## Contributing
// list of initial batches
State if you are open to contributions and what your requirements are for accepting them.
// {(length, density, position), ..}
steady marking {} // optional parameter
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
output arc BTransition
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
place TBPlace (triangular)
function (110, 200, 10, 3600)
## Authors and acknowledgment
// speed, max density, length, and max flow
Show your appreciation to those who have contributed to the project.
initial marking {(1.2, 150, 9.0, 35)}
// list of initial batches
## License
// {(length, density, position, speed), ..}
For open source projects, say how it is licensed.
steady marking {} // optional parameter
output arc BTransition
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
transitions
transition DTransition (discrete)
timing (4) // real value
output arc CPlace (3)
transition CTransition (continuous)
flow (2.0) // real value
steady flow (2) // option parameter
output arc BPlace
output arc TBPlace
transition BTransition (batch)
flow (200.0) // real value
steady flow (150) // option parameter
````
The last block of the input file concerns controlled events. Following the formalism definitions, it is possible to change the maximum flow of a transition and the maximum speed of a place. These controlled events will be included in the scheduler, and the changes will be made at the specified time.
````
// the section of controlled events are option
controlled events
max_flow_change=(flow, BTransition, 3000, 1.15);
// event type, concerned transition, new flow, and time
max_speed_change=(speed, TBPlace, 100, 0.4);
// event type, concerned place, new speed, and time
````
## Textual simulation output
When a compiled model is simulated, an output file is generated. For each date that drives the system's evolution, Simuleau writes the current date, the state of each place and transition, and a list of all upcoming events with their respective dates. The upcoming events that will be processed are listed at the end of each step.
The following listing gives an example of a step in the output file for the example above starting from the initial date.
````
================================================
Current date : 0
================================================
================================================
At the begin of the step
================================================
Name: DPlace
Type: Discrete
Marks: 2
Reserved Marks: 0
Name: CPlace
Type: Continuous
Marks: 5
Reserved Marks: 0
Name: BPlace
Type: Batch
Density: 200
Speed: 110
Length: 10
Batches: 1
(1.2, 150, 2)
Name: CTransition
Type: Continuous
Current Flow: 2
Name: BTransition
Type: Batch
Current Flow: 0
Events
Discrete transition is fired: 1
Date 1 node DTransition
Continuous place becomes empty: 1
Date 2.5 node CPlace
Batch becomes an output batch: 1
Date 0.07272727273 node BPlace
Controlled Events
Transition maximum flow changes: 1
Date 1.15 node BTransition name max_flow_change
Next events to proceed
Event date 0.07272727273 in node BPlace type Batch becomes an output batch
