Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
4
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Switch to GitLab Next
Sign in / Register
Toggle navigation
simpy
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
18
Issues
18
List
Boards
Labels
Service Desk
Milestones
Iterations
Merge Requests
6
Merge Requests
6
Requirements
Requirements
List
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Test Cases
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Operations
Operations
Incidents
Environments
Packages & Registries
Packages & Registries
Package Registry
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issue
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
team-simpy
simpy
Commits
7ba67230
Commit
7ba67230
authored
Sep 03, 2013
by
Stefan Scherfke
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improved and fixed the core API docs.
parent
cd531da3
Changes
5
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
202 additions
and
193 deletions
+202
-193
docs/api_reference/simpy.core.rst
docs/api_reference/simpy.core.rst
+16
-32
docs/api_reference/simpy.rst
docs/api_reference/simpy.rst
+1
-3
docs/index.rst
docs/index.rst
+1
-2
simpy/__init__.py
simpy/__init__.py
+4
-3
simpy/core.py
simpy/core.py
+180
-153
No files found.
docs/api_reference/simpy.core.rst
View file @
7ba67230
...
...
@@ -2,19 +2,19 @@
``simpy.core`` --- SimPy's core components
==========================================
.. automodule:: simpy.core
Environments
============
.. autoclass:: BaseEnvironment
:members:
.. autoclass:: Environment
:members:
:show-inheritance:
:inherited-members:
.. autoclass:: BaseEnvironment
:members:
Events
======
...
...
@@ -24,52 +24,36 @@ Events
.. autoclass:: Process
:members:
:show-inheritance:
.. autoclass:: Timeout
:members:
:show-inheritance:
.. autoclass:: Condition
:members:
:show-inheritance:
.. autoclass:: Initialize
:members:
:show-inheritance:
.. autoclass:: AllOf
:members:
:show-inheritance:
.. autoclass:: AnyOf
:members:
:show-inheritance:
.. autoclass:: Initialize
:members:
Miscellaneous (Interrupt and constants)
=======================================
.. autoclass:: BoundClass
:members:
.. autoclass:: EmptySchedule
.. autoclass:: Interrupt
:members: cause
.. data:: Infinity = inf
Convenience alias for infinity
.. data:: PENDING = object()
Unique object to identify pending values of events
.. data:: HIGH_PRIORITY = 0
Priority of interrupts and Intialize events
.. data:: DEFAULT_PRIORITY = 1
Default priority used by events
.. data:: LOW_PRIORITY = 2
Priority of timeouts
.. autodata:: Infinity
.. autodata:: PENDING
.. autodata:: HIGH_PRIORITY
.. autodata:: DEFAULT_PRIORITY
.. autodata:: LOW_PRIORITY
docs/api_reference/simpy.rst
View file @
7ba67230
==============================
``simpy`` --- The user API
``simpy`` --- The
end
user API
==============================
.. automodule:: simpy
docs/index.rst
View file @
7ba67230
...
...
@@ -3,5 +3,4 @@ SimPy home
==========
..
_templates/index.html contains the content for this page.
.. _templates/index.html contains the content for this page.
simpy/__init__.py
View file @
7ba67230
"""
The ``simpy`` module provides SimPy's end-user API. It therefore
aggregates Simpy's various classes and methods:
The ``simpy`` module provides SimPy's end-user API. It aggregates Simpy's most
important classes and methods. This is purely for your convenience. You can of
course also access everything (and more!) via their actual submodules.
Core classes and functions
...
...
@@ -11,7 +12,7 @@ Core classes and functions
- :class:`Environment`: SimPy's central class. It contains
the simulation's state and lets the PEMs interact with it (i.e.,
schedule events).
- :class:`Process`: This class represents a
PEM
while
- :class:`Process`: This class represents a
process function
while
it is executed in an environment. An instance of it is returned by
:meth:`Environment.start()`. It inherits :class:`Event`.
- :class:`Interrupt`: This exception is thrown into a process if it gets
...
...
simpy/core.py
View file @
7ba67230
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment