Skip to content

Commit e39b73b

Browse files
committed
Update README
1 parent 83ba070 commit e39b73b

1 file changed

Lines changed: 24 additions & 23 deletions

File tree

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,48 @@
1-
SimJulia
2-
========
1+
# SimJulia
32

4-
**SimJulia** is a discrete event process oriented simulation framework written in [Julia](http://julialang.org/) inspired by the Python library [SimPy](https://simpy.readthedocs.io/).
3+
A discrete event process oriented simulation framework written in [Julia](http://julialang.org/) inspired by the Python library [SimPy](https://simpy.readthedocs.io/).
54

6-
#### Build Status
5+
## Build Status
76

87
[![Build Status](https://travis-ci.org/BenLauwens/SimJulia.jl.svg?branch=master)](https://travis-ci.org/BenLauwens/SimJulia.jl)
98
[![Build status](https://ci.appveyor.com/api/projects/status/djuiegytv44pr54c/branch/master?svg=true)](https://ci.appveyor.com/project/BenLauwens/simjulia-jl)
109

1110

12-
#### Coverage
11+
## Coverage
1312

1413
[![Coverage Status](https://coveralls.io/repos/BenLauwens/SimJulia.jl/badge.svg?branch=master)](https://coveralls.io/r/BenLauwens/SimJulia.jl?branch=master)
1514
[![codecov.io](http://codecov.io/github/BenLauwens/SimJulia.jl/coverage.svg?branch=master)](http://codecov.io/github/BenLauwens/SimJulia.jl?branch=master)
1615

1716

18-
#### Installation
17+
## Installation
1918

20-
SimJulia.jl is a [registered package](http://pkg.julialang.org), and is simply installed by running
19+
SimJulia.jl is a [registered package](http://pkg.julialang.org), and is installed by running
2120

2221
```julia
2322
julia> Pkg.add("SimJulia")
2423
```
2524

2625

27-
#### Package Evaluator
26+
## Package Evaluator
2827

2928
[![SimJulia](http://pkg.julialang.org/badges/SimJulia_0.3.svg)](http://pkg.julialang.org/?pkg=SimJulia&ver=0.3)
3029
[![SimJulia](http://pkg.julialang.org/badges/SimJulia_0.4.svg)](http://pkg.julialang.org/?pkg=SimJulia&ver=0.4)
3130
[![SimJulia](http://pkg.julialang.org/badges/SimJulia_0.5.svg)](http://pkg.julialang.org/?pkg=SimJulia&ver=0.5)
3231
[![SimJulia](http://pkg.julialang.org/badges/SimJulia_0.6.svg)](http://pkg.julialang.org/?pkg=SimJulia&ver=0.6)
3332

34-
#### Documentation
33+
## Documentation
3534

3635
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://BenLauwens.github.io/SimJulia.jl/stable)
3736
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://BenLauwens.github.io/SimJulia.jl/latest)
3837

3938

40-
#### Release Notes
39+
## Release Notes
4140

42-
* 2017: Version 0.5 does no longer integrate a continuous time solver. A continuous time solver using SimJulia as its discrete event engine can be found in the repository [QuantizedStateSystems](https://github.com/BenLauwens/QuantizedStateSystems.jl.git):
43-
* Documentation is automated with [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl). (WIP)
44-
* 2017: Version 0.4.1, [ResumableFunctions](https://github.com/BenLauwens/ResumableFunctions.jl.git) is a separate package exporting the `resumable` and `yield` macro and it is a dependency for `SimJulia`. Users have to take into account the following syntax change:
45-
* `@yield return arg` is replaced by `@yield arg`
46-
* 2017: Version 0.4 only supports Julia v0.6 and above. It is a complete rewrite: more julian and less pythonic. The discrete event features are on par with version 0.3 and following features are added:
41+
* 2017: v0.5 does no longer integrate a continuous time solver. A continuous time solver based on the standalone [QSS](https://sourceforge.net/projects/qssengine/) solver using SimJulia as its discrete event engine can be found in the repository [QuantizedStateSystems](https://github.com/BenLauwens/QuantizedStateSystems.jl.git):
42+
* Documentation is automated with [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl).
43+
* 2017: v0.4.1, the `resumable` and `yield` macro are put in a seperate package [ResumableFunctions](https://github.com/BenLauwens/ResumableFunctions.jl.git):
44+
* Users have to take into account the following syntax change: `@yield return arg` is replaced by `@yield arg`.
45+
* 2017: v0.4 only supports Julia v0.6 and above. It is a complete rewrite: more julian and less pythonic. The discrete event features are on par with v0.3 (SimPy v3) and following features are added:
4746
* Scheduling of events can be done with `Base.Dates.Datetime` and `Base.Dates.Period`:
4847
```julia
4948
using SimJulia
@@ -95,22 +94,24 @@ julia> Pkg.add("SimJulia")
9594
@coroutine fibonnaci(sim)
9695
run(sim, 10)
9796
```
98-
* 2015: Version 0.3 synchronizes the API with SimPy v3 and is Julia v0.3, v0.4 and v0.5 compatible:
99-
* Documentation is available at [readthedocs](http://simjuliajl.readthedocs.org/en/latest/)
100-
* 2014: Version 0.2 introduces a continuous time solver and is Julia v0.2 and v0.3 comptabile.
101-
* 2013: Version 0.1 is a Julia clone of SimPy v2 and is Julia v0.2 compatible.
97+
* A continuous time solver based on the standalone [QSS](https://sourceforge.net/projects/qssengine/) solver is implemented. Only non-stiff systems can be solved efficiently.
98+
* 2015: v0.3 synchronizes the API with SimPy v3 and is Julia v0.3, v0.4 and v0.5 compatible:
99+
* Documentation is available at [readthedocs](http://simjuliajl.readthedocs.org/en/latest/).
100+
* The continuous time solver is not implemented.
101+
* 2014: v0.2 introduces a continuous time solver inspired by the Simula library [DISCO](http://www.akira.ruc.dk/~keld/research/DISCO/) and is Julia v0.2 and v0.3 compatible.
102+
* 2013: v0.1 is a Julia clone of SimPy v2 and is Julia v0.2 compatible.
102103

103-
#### Todo
104+
## Todo
104105

105106
* Transparent output processing.
106107
* Automatically running a large number of simulations (over a parameter space) on a cluster to do simulation based optimisation.
107108

108109

109-
#### Authors
110+
## Authors
110111

111-
* Ben Lauwens, Royal Military Academy, Brussels, Belgium
112+
* Ben Lauwens, Royal Military Academy, Brussels, Belgium.
112113

113114

114-
#### License
115+
## License
115116

116117
[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md)

0 commit comments

Comments
 (0)