Commit d4ce2c19 authored by Peter Grayson's avatar Peter Grayson

Various small spelling and grammar repairs

All occurrences of "Simpy" are changed to "SimPy".
parent ab38a332
......@@ -11,7 +11,7 @@ existing SimPy code and documentation environment.
Thanks, guys, for this great job! **SimPy 2.0 is dedicated to you!**
SimPy was originally created by Klaus Müller and Tony Vignaux. They pushed its
development for several years and built the Simpy community. Without them,
development for several years and built the SimPy community. Without them,
there would be no SimPy 3.
Thanks, guys, for this great job! **SimPy 3.0 is dedicated to you!**
......
......@@ -59,7 +59,7 @@ in SimPy 1:
Changes in SimPy 2
==================
Simpy 2 mostly sticked with Simpy 1's design, but added an object orient API
SimPy 2 mostly sticked with SimPy 1's design, but added an object orient API
for the execution of simulations, allowing them to be executed in parallel.
Since processes and the simulation state were so closely coupled, you now
needed to pass the ``Simulation`` instance into your process to "bind" them to
......@@ -130,7 +130,7 @@ The following sections describe these changes in detail:
No More Sub-classing of ``Process``
-----------------------------------
In Simpy 3, every Python generator can be used as a PEM, no matter if it is
In SimPy 3, every Python generator can be used as a PEM, no matter if it is
a module level function or a method of an object. This reduces the amount of
code required for simple processes. The ``Process`` class still exists, but you
don't need to instantiate it by yourself, though. More on that later.
......@@ -157,7 +157,7 @@ separately and were bound to some internal functions that were tightly
integrated with the ``Simulation`` and ``Process`` making it very hard to
extend SimPy with new functionality.
In Simpy 3, PEMs just need to yield events. There are various built-in event
In SimPy 3, PEMs just need to yield events. There are various built-in event
types, but you can also create custom ones by making a subclass of
a ``BaseEvent``. Most events are generated by factory methods of
``Environment``. For example, ``Environment.timeout()`` creates a ``Timeout``
......
......@@ -5,7 +5,7 @@ About SimPy
===========
This sections is all about the non-technical stuff. How did SimPy evolve? Who
was responsible for it? And what the heck were they tinking when they made it?
was responsible for it? And what the heck were they thinking when they made it?
.. toctree::
......
......@@ -5,7 +5,7 @@ API Reference
=============
The API reference provides detailed descriptions of SimPy's classes and
functions. It should be helpful if you plan to extend Simpy with custom
functions. It should be helpful if you plan to extend SimPy with custom
components.
......
......@@ -21,7 +21,7 @@ Vehicles arriving at the gas station first request a fuel pump from the
station. Once they acquire one, they try to take the desired amount of fuel
from the fuel pump. They leave when they are done.
The gas stations fuel level is reqularly monitored by *gas station control*.
The gas stations fuel level is regularly monitored by *gas station control*.
When the level drops below a certain threshold, a *tank truck* is called to
refuel the gas station itself.
......
......@@ -3,7 +3,7 @@
.. figure:: _static/simpy-logo-small.png
:align: center
Event discrete simulation for Python
Discrete event simulation for Python
`News <https://plus.google.com/101634625602509193865>`_ |
`PyPI <https://pypi.python.org/pypi/simpy>`_ |
......
......@@ -97,5 +97,5 @@ passing an end time to it.
What's Next?
============
You should now be familiar with Simpy's terminology and basic concepts. In the
You should now be familiar with SimPy's terminology and basic concepts. In the
:doc:`next section <process_interaction>`, we will cover process interaction.
......@@ -57,7 +57,7 @@ it to finish::
... def charge(self, duration):
... yield self.env.timeout(duration)
Starting the simulation is straight forward again: We create an environment,
Starting the simulation is straightforward again: We create an environment,
one (or more) cars and finally call :meth:`~simpy.core.Environment.run()`.
::
......
......@@ -59,7 +59,8 @@ So keep this in mind:
- Discretization of the time scale can make events appear to be *at the same
time*.
- SimPy processes events *on after another*, even if they have the *samt time*.
- SimPy processes events *one after another*, even if they have the *same
time*.
SimPy Events and time
......@@ -79,7 +80,7 @@ So if we insert events as tuples *(t, event)* (with *t* being the scheduled
time) into it, the first element in the queue will by definition always be the
one with the smallest *t* and the next one to be processed.
However, storing *(t, event)* tuples will not work if two event's are scheduled
However, storing *(t, event)* tuples will not work if two events are scheduled
at the same time because events are not comparable. To fix this, we also store
a strictly increasing event ID with them: *(t, eid, event)*. That way, if two
events get scheduled for the same time, the one scheduled first will always be
......
......@@ -120,7 +120,7 @@ class BaseEnvironment(object):
raise ValueError('until(=%s) should be > the current '
'simulation time.' % at)
# Schedule the event with before all regular timeouts.
# Schedule the event before all regular timeouts.
until = Event(self)
until._ok = True
until._value = None
......
"""
Base classes of for Simpy's shared resource types.
Base classes of for SimPy's shared resource types.
:class:`BaseResource` defines the abstract base resource. It supports *get* and
*put* requests, which return :class:`Put` and :class:`Get` events respectively.
......
"""
Tests for Simpy's real-time behavior.
Tests for SimPy's real-time behavior.
"""
import time
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment