Skip to content

Commit e020f16

Browse files
geraintpalmergeraintpalmer
committed
docs for progress bar, ready for v0.2.6
1 parent 9cdcbc2 commit e020f16

File tree

8 files changed

+80
-27
lines changed

8 files changed

+80
-27
lines changed

‎CHANGES.rst

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
History
22
-------
33

4+
v0.2.6 (2016-10-17)
5+
-------------------
6+
Add AUTHORS.rst.
7+
Add progress bar option.
8+
49
v0.2.5 (2016-10-06)
510
-------------------
611
Fix bug that didn't include .rst files in MANIFEST.in.
@@ -24,41 +29,54 @@ Priority classes implemented.
2429

2530
v0.2.0 (2016-06-20)
2631
-------------------
27-
Python 3.4 and 3.5 compatible along with 2.7. Data records now kept in list.
32+
Python 3.4 and 3.5 compatible along with 2.7.
33+
Data records now kept in list.
2834

2935
v0.1.1 (2016-06-06)
3036
-------------------
31-
Ability to incorporate behaviour nodes, data records are now named tuples.
37+
Ability to incorporate behaviour nodes.
38+
Data records are now named tuples.
3239

3340
v0.1.0 (2016-04-25)
3441
-------------------
35-
Re-factor inputs. Simulation takes in a Network object, helper functions to import yml and dictionary to a Network object. Simulation object takes optional
36-
arguments: deadlock_detector, exact, tracker. simulate_until_max_time() takes argument max_simulation_time.
42+
Re-factor inputs.
43+
Simulation takes in a Network object.
44+
Helper functions to import yml and dictionary to a Network object.
45+
Simulation object takes optional arguments: deadlock_detector, exact, tracker.
46+
simulate_until_max_time() takes argument max_simulation_time.
3747

3848
v0.0.6 (2016-04-04)
3949
-------------------
40-
Exactness implemented, restructure some features e.g. times_to_deadlock, custom simulation names
50+
Exactness implemented.
51+
Restructure some features e.g. times_to_deadlock.
52+
Custom simulation names.
4153

4254
v0.0.5 (2016-03-18)
4355
-------------------
44-
State space tracker plug-and-playable, add rejection dictionary
56+
State space tracker plug-and-playable.
57+
Add rejection dictionary.
4558

4659
v0.0.4 (2016-02-20)
4760
-------------------
48-
Empirical and UserDefined distributions added, tidy ups
61+
Empirical and UserDefined distributions added.
62+
Tidy ups.
4963

5064
v0.0.3 (2016-02-09)
5165
-------------------
52-
Arrival distributions, MMC options removed, fix server schedule bugs
66+
Arrival distributions.
67+
MMC options removed.
68+
Fix server schedule bugs.
5369

5470
v0.0.2 (2016-01-06)
5571
-------------------
56-
Some kwargs optional, hypothesis tests, minor enhancements
72+
Some kwargs optional.
73+
Hypothesis tests.
74+
Minor enhancements.
5775

5876
v0.0.1 (2015-12-14)
5977
-------------------
60-
Initial release
78+
Initial release.
6179

6280
v0.0.1dev (2015-12-14)
6381
----------------------
64-
Initial release (dev)
82+
Initial release (dev).

‎ciw/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
from .import_params import *
1414
from .network import *
1515

16-
__version__ = '0.2.5'
16+
__version__ = '0.2.6'

‎docs/Features/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Contents:
99
.. toctree::
1010
:maxdepth: 2
1111

12+
seed.rst
13+
progress_bar.rst
1214
distributions.rst
1315
custom_dists.rst
1416
baulking.rst
@@ -18,4 +20,3 @@ Contents:
1820
deadlock.rst
1921
state_tracker.rst
2022
exact.rst
21-
seed.rst

‎docs/Features/progress_bar.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _progress-bars:
2+
3+
============
4+
Progress Bar
5+
============
6+
7+
For an individual run of a simulation, Ciw can enable a progress bar to appear. This can help visualise how far through a simulation run currently is. In order to implement this, add the option :code:`progress_bar=True` to the :code:`simulate_until_max_time` method:
8+
9+
>>> Q.simulate_until_max_time(1500, progress_bar=True) # doctest:+SKIP
10+
11+
The image below shows an example of the output:
12+
13+
.. image:: ../_static/progress_bar.png
14+
:scale: 100 %
15+
:alt: Output of progress bar.
16+
:align: center

‎docs/_static/progress_bar.png

21.6 KB
Loading

‎docs/changelog.rst

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
Change Log
44
==========
55

6+
v0.2.6 (2016-10-17)
7+
-------------------
8+
Add AUTHORS.rst.
9+
Add progress bar option.
10+
611
v0.2.5 (2016-10-06)
712
-------------------
813
Fix bug that didn't include .rst files in MANIFEST.in.
@@ -26,41 +31,54 @@ Priority classes implemented.
2631

2732
v0.2.0 (2016-06-20)
2833
-------------------
29-
Python 3.4 and 3.5 compatible along with 2.7. Data records now kept in list.
34+
Python 3.4 and 3.5 compatible along with 2.7.
35+
Data records now kept in list.
3036

3137
v0.1.1 (2016-06-06)
3238
-------------------
33-
Ability to incorporate behaviour nodes, data records are now named tuples.
39+
Ability to incorporate behaviour nodes.
40+
Data records are now named tuples.
3441

3542
v0.1.0 (2016-04-25)
3643
-------------------
37-
Re-factor inputs. Simulation takes in a Network object, helper functions to import yml and dictionary to a Network object. Simulation object takes optional
38-
arguments: deadlock_detector, exact, tracker. simulate_until_max_time() takes argument max_simulation_time.
44+
Re-factor inputs.
45+
Simulation takes in a Network object.
46+
Helper functions to import yml and dictionary to a Network object.
47+
Simulation object takes optional arguments: deadlock_detector, exact, tracker.
48+
simulate_until_max_time() takes argument max_simulation_time.
3949

4050
v0.0.6 (2016-04-04)
4151
-------------------
42-
Exactness implemented, restructure some features e.g. times_to_deadlock, custom simulation names
52+
Exactness implemented.
53+
Restructure some features e.g. times_to_deadlock.
54+
Custom simulation names.
4355

4456
v0.0.5 (2016-03-18)
4557
-------------------
46-
State space tracker plug-and-playable, add rejection dictionary
58+
State space tracker plug-and-playable.
59+
Add rejection dictionary.
4760

4861
v0.0.4 (2016-02-20)
4962
-------------------
50-
Empirical and UserDefined distributions added, tidy ups
63+
Empirical and UserDefined distributions added.
64+
Tidy ups.
5165

5266
v0.0.3 (2016-02-09)
5367
-------------------
54-
Arrival distributions, MMC options removed, fix server schedule bugs
68+
Arrival distributions.
69+
MMC options removed.
70+
Fix server schedule bugs.
5571

5672
v0.0.2 (2016-01-06)
5773
-------------------
58-
Some kwargs optional, hypothesis tests, minor enhancements
74+
Some kwargs optional.
75+
Hypothesis tests.
76+
Minor enhancements.
5977

6078
v0.0.1 (2015-12-14)
6179
-------------------
62-
Initial release
80+
Initial release.
6381

6482
v0.0.1dev (2015-12-14)
6583
----------------------
66-
Initial release (dev)
84+
Initial release (dev).

‎docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@
5959
# built documents.
6060
#
6161
# The short X.Y version.
62-
version = '0.2.5'
62+
version = '0.2.6'
6363
# The full version, including alpha/beta/rc tags.
64-
release = '0.2.5'
64+
release = '0.2.6'
6565

6666
# The language for content autogenerated by Sphinx. Refer to documentation
6767
# for a list of supported languages.

‎setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
setup(
1313
name='Ciw',
14-
version='0.2.5',
14+
version='0.2.6',
1515
url='https://github.com/geraintpalmer/Ciw',
1616
author='Geraint Palmer, Vincent Knight',
1717
author_email='[email protected]',

0 commit comments

Comments
 (0)