Getting Started
Installation
Requirements
Install from PyPI
Optional Dependencies
Visualization
Reinforcement Learning
All Dependencies
Development
Install from Source
Verify Installation
Quick Start
Hello World
Core Concepts
Simulation
Scheduling Events
Random Numbers
M/M/1 Queue Example
Next Steps
Tutorials
Tutorials
Getting Started
Building Your First Simulation
What You’ll Learn
The Scenario
Step 1: Create the Simulation Class
Step 2: Handle Customer Arrivals
Step 3: Handle Service Events
Step 4: Add Reporting
Step 5: Run the Simulation
Complete Code
Running the Simulation
Experimentation
Next Steps
Reinforcement Learning Integration
What You’ll Learn
Overview
Step 1: Define the Problem
Step 2: Implement RLInterface
Step 3: Create the Gym Environment
Step 4: Training Loop
Using with Stable-Baselines3
Decision Points
Multi-Agent RL
Next Steps
Tutorial Overview
Prerequisites
Learning Path
Examples
Examples
Available Examples
M/M/1 Queue Example
Overview
Queueing Theory Background
Code Walkthrough
Running the Example
Sample Output
Extending the Example
Source Code
Manufacturing Example
Overview
The Manufacturing Process
Code Walkthrough
Running the Example
Sample Output
Key Patterns Demonstrated
Extensions
Source Code
Port Terminal Example
Overview
Terminal Operations
Code Walkthrough
RL Integration
Running the Example
Sample Output
Key Patterns
Source Code
Example Overview
Running Examples
Learning Path
API Reference
API Reference
Modules
Core Module
Simulation
Event
Entity
Clock
Resources Module
Server
Queue
Resource
Resource Pool
Statistics Module
Counter
Tally
TimeSeries
Monitor
Activities Module
Activity
State Machine
Random Module
RandomGenerator
Stream Management
Alternative Generators
Optimization Module
Optimization Interface
Reinforcement Learning Interface
Utils Module
Configuration
Logging
Visualization
Module Overview
Project Info
Changelog
[1.0.0] - 2024-12-28
Added
Documentation
SimCraft
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
_
__init__() (simcraft.activities.activity.Activity method)
(simcraft.activities.activity.ActivityStats method)
(simcraft.activities.activity.ParallelActivity method)
(simcraft.activities.state_machine.State method)
(simcraft.activities.state_machine.StateMachine method)
(simcraft.activities.state_machine.StateMachineInstance method)
(simcraft.activities.state_machine.Transition method)
(simcraft.core.clock.Clock method)
(simcraft.core.entity.EntityFactory method)
(simcraft.core.entity.EntityPool method)
(simcraft.core.event.ConditionalEvent method)
(simcraft.core.event.Event method)
(simcraft.core.event.EventList method)
(simcraft.core.simulation.SimulationConfig method)
(simcraft.Counter method)
(simcraft.Entity method)
(simcraft.Monitor method)
(simcraft.optimization.base.EvaluationResult method)
(simcraft.optimization.base.Parameter method)
(simcraft.optimization.base.SimulationExperiment method)
(simcraft.optimization.base.SimulationObjective method)
(simcraft.optimization.rl_interface.ActionSpace method)
(simcraft.optimization.rl_interface.DecisionPoint method)
(simcraft.optimization.rl_interface.MultiAgentInterface method)
(simcraft.optimization.rl_interface.ReplayBuffer method)
(simcraft.optimization.rl_interface.RLEnvironment method)
(simcraft.optimization.rl_interface.StateSpace method)
(simcraft.optimization.rl_interface.Transition method)
(simcraft.Queue method)
(simcraft.random.distributions.LCG method)
(simcraft.random.streams.CommonRandomNumbers method)
(simcraft.random.streams.RandomStream method)
(simcraft.random.streams.StreamManager method)
(simcraft.RandomGenerator method)
(simcraft.Resource method)
(simcraft.ResourcePool method)
(simcraft.resources.pool.PooledResource method)
(simcraft.resources.pool.PoolStats method)
(simcraft.resources.queue.PriorityQueue method)
(simcraft.resources.queue.QueueStats method)
(simcraft.resources.resource.PreemptiveResource method)
(simcraft.resources.resource.ResourceStats method)
(simcraft.resources.server.MultiStageServer method)
(simcraft.resources.server.ServerStats method)
(simcraft.Server method)
(simcraft.Simulation method)
(simcraft.statistics.counter.WindowedCounter method)
(simcraft.statistics.monitor.SimulationRecorder method)
(simcraft.statistics.tally.BatchTally method)
(simcraft.statistics.time_series.CapacityTimeSeries method)
(simcraft.Tally method)
(simcraft.TimeSeries method)
(simcraft.utils.config.SimulationConfig method)
(simcraft.utils.config.YAMLConfig method)
(simcraft.utils.logging.SimulationLogger method)
A
acquire() (simcraft.core.entity.EntityPool method)
(simcraft.Resource method)
(simcraft.ResourcePool method)
(simcraft.resources.resource.PreemptiveResource method)
(simcraft.statistics.time_series.CapacityTimeSeries method)
acquisitions (simcraft.resources.resource.ResourceStats attribute)
,
[1]
action (simcraft.activities.state_machine.Transition attribute)
,
[1]
(simcraft.core.event.ConditionalEvent attribute)
,
[1]
(simcraft.core.event.Event attribute)
,
[1]
(simcraft.optimization.rl_interface.Transition attribute)
,
[1]
action_space (simcraft.optimization.rl_interface.DecisionPoint property)
(simcraft.optimization.rl_interface.RLEnvironment property)
ActionSpace (class in simcraft.optimization.rl_interface)
activate() (simcraft.Entity method)
ACTIVE (simcraft.core.entity.EntityState attribute)
Activity (class in simcraft.activities.activity)
ActivityState (class in simcraft.activities.activity)
ActivityStats (class in simcraft.activities.activity)
add() (simcraft.core.event.EventList method)
add_agent() (simcraft.optimization.rl_interface.MultiAgentInterface method)
add_collector() (simcraft.statistics.monitor.SimulationRecorder method)
add_counter() (simcraft.Monitor method)
add_custom_metric() (simcraft.Monitor method)
add_monitor() (simcraft.Simulation method)
add_resource() (simcraft.ResourcePool method)
add_state() (simcraft.activities.state_machine.StateMachine method)
add_tally() (simcraft.Monitor method)
add_time_series() (simcraft.Monitor method)
add_timed_transition() (simcraft.activities.state_machine.StateMachine method)
add_transition() (simcraft.activities.state_machine.StateMachine method)
advance() (simcraft.core.clock.Clock method)
advance_to() (simcraft.core.clock.Clock method)
agent_names (simcraft.optimization.rl_interface.MultiAgentInterface property)
allocated (simcraft.Resource property)
ALLOCATED (simcraft.resources.resource.ResourceState attribute)
allocated_count (simcraft.ResourcePool property)
allocations (simcraft.resources.pool.PooledResource attribute)
,
[1]
apply_action() (simcraft.optimization.rl_interface.DecisionPoint method)
(simcraft.optimization.rl_interface.RLInterface method)
apply_actions() (simcraft.optimization.rl_interface.MultiAgentInterface method)
area (simcraft.resources.queue.QueueStats attribute)
,
[1]
args (simcraft.core.event.ConditionalEvent attribute)
(simcraft.core.event.Event attribute)
,
[1]
arrivals (simcraft.resources.server.ServerStats attribute)
,
[1]
attributes (simcraft.Entity attribute)
,
[1]
available (simcraft.Resource property)
AVAILABLE (simcraft.resources.resource.ResourceState attribute)
available (simcraft.statistics.time_series.CapacityTimeSeries property)
available_capacity (simcraft.activities.activity.Activity property)
(simcraft.activities.activity.ParallelActivity property)
(simcraft.Server property)
available_count (simcraft.core.entity.EntityPool property)
(simcraft.ResourcePool property)
average_duration (simcraft.TimeSeries property)
average_hold_time (simcraft.resources.resource.ResourceStats property)
average_length (simcraft.resources.queue.QueueStats property)
average_processing (simcraft.activities.activity.ActivityStats property)
average_processing_time (simcraft.activities.activity.ActivityStats property)
average_service_time (simcraft.resources.server.ServerStats property)
average_value (simcraft.TimeSeries property)
average_wait (simcraft.resources.queue.QueueStats property)
average_wait_time (simcraft.activities.activity.ActivityStats property)
(simcraft.resources.resource.ResourceStats property)
average_waiting (simcraft.activities.activity.ActivityStats property)
B
balked (simcraft.resources.server.ServerStats attribute)
,
[1]
batch_count (simcraft.statistics.tally.BatchTally property)
batch_means (simcraft.statistics.tally.BatchTally property)
batch_variance() (simcraft.statistics.tally.BatchTally method)
BatchTally (class in simcraft.statistics.tally)
bernoulli() (simcraft.RandomGenerator method)
best_result (simcraft.optimization.base.SimulationExperiment property)
beta() (simcraft.RandomGenerator method)
binomial() (simcraft.RandomGenerator method)
block() (simcraft.Entity method)
BLOCKED (simcraft.core.entity.EntityState attribute)
(simcraft.resources.server.ServerState attribute)
blocked_time (simcraft.resources.server.ServerStats attribute)
,
[1]
box() (simcraft.optimization.rl_interface.StateSpace class method)
BUSY (simcraft.resources.server.ServerState attribute)
busy_time (simcraft.resources.server.ServerStats attribute)
,
[1]
C
can_fire() (simcraft.activities.state_machine.Transition method)
can_trigger() (simcraft.activities.state_machine.StateMachineInstance method)
cancel() (simcraft.core.event.Event method)
cancel_event() (simcraft.Simulation method)
cancel_events_by_tag() (simcraft.Simulation method)
cancel_request() (simcraft.Resource method)
cancelled (simcraft.core.event.Event attribute)
,
[1]
capacity (simcraft.activities.activity.Activity property)
(simcraft.Queue property)
(simcraft.Resource property)
(simcraft.Server property)
(simcraft.statistics.time_series.CapacityTimeSeries property)
CapacityTimeSeries (class in simcraft.statistics.time_series)
check_and_execute() (simcraft.core.event.ConditionalEvent method)
check_interval (simcraft.core.event.ConditionalEvent attribute)
,
[1]
checkpoint() (simcraft.random.streams.RandomStream method)
(simcraft.random.streams.StreamManager method)
choice() (simcraft.RandomGenerator method)
choices() (simcraft.RandomGenerator method)
clear() (simcraft.core.event.EventList method)
(simcraft.optimization.base.SimulationExperiment method)
(simcraft.optimization.rl_interface.ReplayBuffer method)
(simcraft.Queue method)
(simcraft.statistics.monitor.SimulationRecorder method)
clear_history() (simcraft.optimization.rl_interface.RLEnvironment method)
Clock (class in simcraft.core.clock)
clock (simcraft.Simulation property)
collect_trace (simcraft.core.simulation.SimulationConfig attribute)
,
[1]
(simcraft.utils.config.SimulationConfig attribute)
CommonRandomNumbers (class in simcraft.random.streams)
complete() (simcraft.Entity method)
COMPLETED (simcraft.activities.activity.ActivityState attribute)
(simcraft.core.entity.EntityState attribute)
(simcraft.core.simulation.SimulationState attribute)
completions (simcraft.activities.activity.ActivityStats attribute)
,
[1]
condition (simcraft.core.event.ConditionalEvent attribute)
,
[1]
ConditionalEvent (class in simcraft.core.event)
confidence_interval() (simcraft.Tally method)
ConfigLoader (class in simcraft.utils.config)
constraints (simcraft.optimization.base.EvaluationResult attribute)
,
[1]
contains() (simcraft.Queue method)
context (simcraft.activities.state_machine.StateMachineInstance property)
continuous() (simcraft.optimization.rl_interface.ActionSpace class method)
convert() (simcraft.core.clock.Clock method)
count (simcraft.Tally property)
Counter (class in simcraft)
counters (simcraft.Monitor property)
create() (simcraft.core.entity.EntityFactory method)
create_instance() (simcraft.activities.state_machine.StateMachine method)
create_stream() (simcraft.random.streams.StreamManager method)
CREATED (simcraft.core.entity.EntityState attribute)
(simcraft.core.simulation.SimulationState attribute)
created_at (simcraft.Entity attribute)
,
[1]
created_count (simcraft.core.entity.EntityFactory property)
cumulative_value (simcraft.TimeSeries property)
current_length (simcraft.resources.queue.QueueStats property)
current_state (simcraft.activities.state_machine.StateMachineInstance property)
current_step (simcraft.optimization.rl_interface.RLEnvironment property)
current_value (simcraft.TimeSeries property)
CUSTOM (simcraft.resources.pool.PoolSelectionPolicy attribute)
D
datetime_now (simcraft.core.clock.Clock property)
DAYS (simcraft.core.clock.TimeUnit attribute)
debug() (simcraft.utils.logging.SimulationLogger method)
DecisionPoint (class in simcraft.optimization.rl_interface)
decrement() (simcraft.Counter method)
decrement_count (simcraft.TimeSeries property)
decrement_rate (simcraft.TimeSeries property)
departures (simcraft.activities.activity.ActivityStats attribute)
,
[1]
(simcraft.resources.server.ServerStats attribute)
,
[1]
dequeue() (simcraft.Queue method)
(simcraft.resources.queue.PriorityQueue method)
description (simcraft.optimization.base.Parameter attribute)
,
[1]
direction (simcraft.optimization.base.SimulationObjective attribute)
,
[1]
disable_antithetic() (simcraft.random.streams.StreamManager method)
discrete() (simcraft.optimization.rl_interface.ActionSpace class method)
dispose() (simcraft.Entity method)
DISPOSED (simcraft.core.entity.EntityState attribute)
done (simcraft.optimization.rl_interface.Transition attribute)
,
[1]
DOWN (simcraft.resources.resource.ResourceState attribute)
(simcraft.resources.server.ServerState attribute)
down_time (simcraft.resources.server.ServerStats attribute)
,
[1]
dtype (simcraft.optimization.rl_interface.StateSpace attribute)
,
[1]
duration (simcraft.utils.config.SimulationConfig attribute)
,
[1]
E
elapsed (simcraft.core.clock.Clock property)
elapsed_since_warmup (simcraft.core.clock.Clock property)
elapsed_time (simcraft.Counter property)
(simcraft.TimeSeries property)
empirical() (simcraft.RandomGenerator method)
empirical_continuous() (simcraft.RandomGenerator method)
enable_antithetic() (simcraft.random.streams.StreamManager method)
enable_event_logging() (simcraft.Monitor method)
enqueue() (simcraft.Queue method)
(simcraft.resources.queue.PriorityQueue method)
(simcraft.resources.server.MultiStageServer method)
(simcraft.Server method)
enter_service() (simcraft.Entity method)
Entity (class in simcraft)
EntityFactory (class in simcraft.core.entity)
EntityPool (class in simcraft.core.entity)
EntityState (class in simcraft.core.entity)
entries (simcraft.activities.activity.ActivityStats attribute)
,
[1]
(simcraft.resources.queue.QueueStats attribute)
,
[1]
episode (simcraft.optimization.rl_interface.RLEnvironment property)
erlang() (simcraft.RandomGenerator method)
error() (simcraft.utils.logging.SimulationLogger method)
evaluate() (simcraft.optimization.base.OptimizationInterface method)
evaluate_full() (simcraft.optimization.base.OptimizationInterface method)
EvaluationResult (class in simcraft.optimization.base)
Event (class in simcraft.core.event)
event() (simcraft.utils.logging.SimulationLogger method)
EventList (class in simcraft.core.event)
events_pending (simcraft.Simulation property)
events_processed (simcraft.Simulation property)
exits (simcraft.resources.queue.QueueStats attribute)
,
[1]
exponential() (simcraft.random.distributions.LCG method)
(simcraft.RandomGenerator method)
export_results() (simcraft.optimization.base.SimulationExperiment method)
F
failed_acquisitions (simcraft.resources.pool.PoolStats attribute)
,
[1]
fire() (simcraft.activities.state_machine.Transition method)
FIRST_AVAILABLE (simcraft.resources.pool.PoolSelectionPolicy attribute)
force_state() (simcraft.activities.state_machine.StateMachineInstance method)
fork() (simcraft.random.streams.RandomStream method)
from_dict() (simcraft.utils.config.YAMLConfig class method)
from_file() (simcraft.utils.config.YAMLConfig class method)
from_hours() (simcraft.core.clock.TimeUnit method)
G
gamma() (simcraft.RandomGenerator method)
geometric() (simcraft.RandomGenerator method)
get_action_space() (simcraft.optimization.rl_interface.RLInterface method)
get_agent() (simcraft.optimization.rl_interface.MultiAgentInterface method)
get_allocated() (simcraft.ResourcePool method)
get_attribute() (simcraft.Entity method)
get_available() (simcraft.ResourcePool method)
get_average_utilization() (simcraft.ResourcePool method)
get_completed() (simcraft.activities.activity.Activity method)
get_constraints() (simcraft.optimization.base.OptimizationInterface method)
get_counter() (simcraft.Monitor method)
get_entities_in_service() (simcraft.Server method)
get_events() (simcraft.Monitor method)
get_history() (simcraft.optimization.rl_interface.RLEnvironment method)
(simcraft.Tally method)
(simcraft.TimeSeries method)
get_info() (simcraft.optimization.rl_interface.RLInterface method)
get_initial_point() (simcraft.optimization.base.OptimizationInterface method)
get_monitor() (simcraft.Simulation method)
get_objectives() (simcraft.optimization.base.OptimizationInterface method)
get_parameter_bounds() (simcraft.optimization.base.OptimizationInterface method)
get_parameters() (simcraft.optimization.base.OptimizationInterface method)
get_pending() (simcraft.activities.activity.Activity method)
get_processing() (simcraft.activities.activity.Activity method)
get_records() (simcraft.statistics.monitor.SimulationRecorder method)
get_resource() (simcraft.ResourcePool method)
get_reward() (simcraft.optimization.rl_interface.DecisionPoint method)
(simcraft.optimization.rl_interface.RLInterface method)
get_rewards() (simcraft.optimization.rl_interface.MultiAgentInterface method)
get_stage() (simcraft.resources.server.MultiStageServer method)
get_state() (simcraft.activities.state_machine.StateMachine method)
(simcraft.optimization.rl_interface.DecisionPoint method)
(simcraft.optimization.rl_interface.RLInterface method)
(simcraft.RandomGenerator method)
get_state_space() (simcraft.optimization.rl_interface.RLInterface method)
get_states() (simcraft.optimization.rl_interface.MultiAgentInterface method)
get_stream() (simcraft.random.streams.CommonRandomNumbers method)
(simcraft.random.streams.StreamManager method)
get_tally() (simcraft.Monitor method)
get_time_series() (simcraft.Monitor method)
get_trace() (simcraft.Simulation method)
get_transitions_from() (simcraft.activities.state_machine.StateMachine method)
get_utilization() (simcraft.ResourcePool method)
guard (simcraft.activities.state_machine.Transition attribute)
,
[1]
H
has_attribute() (simcraft.Entity method)
has_available (simcraft.ResourcePool property)
high (simcraft.optimization.rl_interface.ActionSpace attribute)
,
[1]
(simcraft.optimization.rl_interface.StateSpace attribute)
,
[1]
histogram() (simcraft.TimeSeries method)
history (simcraft.activities.state_machine.StateMachineInstance property)
HOURS (simcraft.core.clock.TimeUnit attribute)
I
id (simcraft.Entity attribute)
,
[1]
(simcraft.resources.pool.PooledResource attribute)
,
[1]
IDLE (simcraft.resources.server.ServerState attribute)
idle_time (simcraft.resources.server.ServerStats attribute)
,
[1]
IN_SERVICE (simcraft.core.entity.EntityState attribute)
in_service_count (simcraft.Server property)
in_use_count (simcraft.core.entity.EntityPool property)
INCREMENT (simcraft.random.distributions.LCG attribute)
increment() (simcraft.Counter method)
(simcraft.statistics.counter.WindowedCounter method)
increment_count (simcraft.TimeSeries property)
increment_rate (simcraft.TimeSeries property)
index (simcraft.core.event.Event attribute)
,
[1]
(simcraft.Entity property)
info (simcraft.optimization.rl_interface.Transition attribute)
,
[1]
info() (simcraft.utils.logging.SimulationLogger method)
initial_state (simcraft.activities.state_machine.StateMachine property)
initial_value (simcraft.optimization.base.Parameter attribute)
,
[1]
INITIALIZED (simcraft.core.simulation.SimulationState attribute)
interarrival_time() (simcraft.RandomGenerator method)
invoke() (simcraft.core.event.Event method)
is_active (simcraft.Entity property)
is_available (simcraft.Resource property)
(simcraft.resources.pool.PooledResource attribute)
,
[1]
is_busy (simcraft.Server property)
(simcraft.statistics.time_series.CapacityTimeSeries property)
is_completed (simcraft.Entity property)
is_disposed (simcraft.Entity property)
is_done() (simcraft.optimization.rl_interface.RLInterface method)
is_empty (simcraft.Queue property)
(simcraft.ResourcePool property)
(simcraft.resources.queue.PriorityQueue property)
is_feasible (simcraft.optimization.base.EvaluationResult property)
is_final (simcraft.activities.state_machine.State attribute)
,
[1]
is_full (simcraft.Queue property)
(simcraft.resources.queue.PriorityQueue property)
is_idle (simcraft.Server property)
(simcraft.statistics.time_series.CapacityTimeSeries property)
is_in_final_state (simcraft.activities.state_machine.StateMachineInstance property)
is_initial (simcraft.activities.state_machine.State attribute)
,
[1]
is_integer (simcraft.optimization.base.Parameter attribute)
,
[1]
is_minimization (simcraft.optimization.base.SimulationObjective property)
is_running (simcraft.Simulation property)
is_waiting (simcraft.Entity property)
is_warmed_up (simcraft.core.clock.Clock attribute)
(simcraft.core.clock.Clock property)
(simcraft.Simulation property)
K
keep_history (simcraft.Tally attribute)
kwargs (simcraft.core.event.ConditionalEvent attribute)
(simcraft.core.event.Event attribute)
,
[1]
L
LCG (class in simcraft.random.distributions)
LEAST_UTILIZED (simcraft.resources.pool.PoolSelectionPolicy attribute)
load() (simcraft.utils.config.ConfigLoader static method)
load_checkpoint() (simcraft.random.streams.CommonRandomNumbers method)
log_event() (simcraft.Monitor method)
log_level (simcraft.core.simulation.SimulationConfig attribute)
,
[1]
(simcraft.utils.config.SimulationConfig attribute)
lognormal() (simcraft.RandomGenerator method)
low (simcraft.optimization.rl_interface.ActionSpace attribute)
,
[1]
(simcraft.optimization.rl_interface.StateSpace attribute)
,
[1]
lower_bound (simcraft.optimization.base.Parameter attribute)
,
[1]
M
max (simcraft.Tally property)
max_attempts (simcraft.core.event.ConditionalEvent attribute)
,
[1]
max_events (simcraft.core.simulation.SimulationConfig attribute)
,
[1]
max_length (simcraft.resources.queue.QueueStats attribute)
,
[1]
max_value (simcraft.TimeSeries property)
MAXIMIZE (simcraft.optimization.base.ObjectiveType attribute)
mean (simcraft.Tally property)
metadata (simcraft.activities.state_machine.State attribute)
,
[1]
(simcraft.optimization.base.EvaluationResult attribute)
,
[1]
min (simcraft.Tally property)
min_value (simcraft.TimeSeries property)
MINIMIZE (simcraft.optimization.base.ObjectiveType attribute)
MINUTES (simcraft.core.clock.TimeUnit attribute)
MODULUS (simcraft.random.distributions.LCG attribute)
Monitor (class in simcraft)
multi_discrete() (simcraft.optimization.rl_interface.ActionSpace class method)
MultiAgentInterface (class in simcraft.optimization.rl_interface)
MULTIPLIER (simcraft.random.distributions.LCG attribute)
MultiStageServer (class in simcraft.resources.server)
N
n (simcraft.optimization.rl_interface.ActionSpace attribute)
,
[1]
n_agents (simcraft.optimization.rl_interface.MultiAgentInterface property)
name (simcraft.activities.activity.Activity property)
(simcraft.activities.state_machine.State attribute)
,
[1]
(simcraft.activities.state_machine.StateMachine property)
(simcraft.Counter attribute)
(simcraft.Monitor property)
(simcraft.optimization.base.Parameter attribute)
,
[1]
(simcraft.optimization.base.SimulationObjective attribute)
,
[1]
(simcraft.Queue property)
(simcraft.random.streams.RandomStream property)
(simcraft.Resource property)
(simcraft.ResourcePool property)
(simcraft.resources.queue.PriorityQueue property)
(simcraft.Server property)
(simcraft.Simulation property)
(simcraft.statistics.counter.WindowedCounter property)
(simcraft.Tally attribute)
(simcraft.TimeSeries property)
(simcraft.utils.config.SimulationConfig attribute)
,
[1]
negative_binomial() (simcraft.RandomGenerator method)
next_state (simcraft.optimization.rl_interface.Transition attribute)
,
[1]
normal() (simcraft.RandomGenerator method)
normalize() (simcraft.optimization.base.SimulationObjective method)
now (simcraft.core.clock.Clock attribute)
,
[1]
(simcraft.Simulation property)
now_in() (simcraft.core.clock.Clock method)
num_stages (simcraft.resources.server.MultiStageServer property)
nvec (simcraft.optimization.rl_interface.ActionSpace attribute)
,
[1]
O
objectives (simcraft.optimization.base.EvaluationResult attribute)
,
[1]
ObjectiveType (class in simcraft.optimization.base)
observation_space (simcraft.optimization.rl_interface.RLEnvironment property)
observe() (simcraft.statistics.tally.BatchTally method)
(simcraft.Tally method)
observe_batch() (simcraft.Tally method)
observe_change() (simcraft.TimeSeries method)
observe_value() (simcraft.TimeSeries method)
occupancy (simcraft.activities.activity.Activity property)
on_arrival() (simcraft.Server method)
on_balk() (simcraft.Server method)
on_complete() (simcraft.activities.activity.Activity method)
on_completion() (simcraft.resources.server.MultiStageServer method)
on_departure() (simcraft.activities.activity.Activity method)
(simcraft.activities.activity.ParallelActivity method)
(simcraft.Server method)
on_dequeue() (simcraft.Queue method)
on_end() (simcraft.Simulation method)
on_enqueue() (simcraft.Queue method)
on_enter (simcraft.activities.state_machine.State attribute)
,
[1]
on_exit (simcraft.activities.state_machine.State attribute)
,
[1]
on_init() (simcraft.Simulation method)
on_preempt() (simcraft.resources.resource.PreemptiveResource method)
on_service_start() (simcraft.Server method)
on_start() (simcraft.activities.activity.Activity method)
on_state_enter() (simcraft.activities.state_machine.StateMachine method)
on_state_exit() (simcraft.activities.state_machine.StateMachine method)
on_stay (simcraft.activities.state_machine.State attribute)
,
[1]
on_transition() (simcraft.activities.state_machine.StateMachine method)
on_warmup_end() (simcraft.Simulation method)
OptimizationInterface (class in simcraft.optimization.base)
owner (simcraft.core.event.Event attribute)
,
[1]
P
ParallelActivity (class in simcraft.activities.activity)
Parameter (class in simcraft.optimization.base)
parameters (simcraft.optimization.base.EvaluationResult attribute)
,
[1]
parent (simcraft.Simulation property)
pareto() (simcraft.RandomGenerator method)
PAUSED (simcraft.core.simulation.SimulationState attribute)
peek() (simcraft.Queue method)
(simcraft.resources.queue.PriorityQueue method)
peek_next() (simcraft.core.event.EventList method)
PENDING (simcraft.activities.activity.ActivityState attribute)
pending_count (simcraft.activities.activity.Activity property)
(simcraft.activities.activity.ParallelActivity property)
percentile() (simcraft.Tally method)
(simcraft.TimeSeries method)
plot_histogram() (in module simcraft.utils.visualization)
plot_time_series() (in module simcraft.utils.visualization)
poisson() (simcraft.RandomGenerator method)
PooledResource (class in simcraft.resources.pool)
PoolSelectionPolicy (class in simcraft.resources.pool)
PoolStats (class in simcraft.resources.pool)
pop_next() (simcraft.core.event.EventList method)
preempt() (simcraft.Server method)
PreemptiveResource (class in simcraft.resources.resource)
priority (simcraft.activities.state_machine.Transition attribute)
,
[1]
(simcraft.core.event.Event attribute)
,
[1]
PriorityQueue (class in simcraft.resources.queue)
PROCESSING (simcraft.activities.activity.ActivityState attribute)
processing_count (simcraft.activities.activity.Activity property)
push() (simcraft.optimization.rl_interface.ReplayBuffer method)
Q
Queue (class in simcraft)
queue (simcraft.Server property)
queue_length (simcraft.Server property)
QueueStats (class in simcraft.resources.queue)
R
randint() (simcraft.RandomGenerator method)
RandomGenerator (class in simcraft)
RandomStream (class in simcraft.random.streams)
range (simcraft.Tally property)
rate (simcraft.Counter property)
READY_TO_DEPART (simcraft.activities.activity.ActivityState attribute)
READY_TO_FINISH (simcraft.activities.activity.ActivityState attribute)
READY_TO_START (simcraft.activities.activity.ActivityState attribute)
real_time_factor (simcraft.core.simulation.SimulationConfig attribute)
,
[1]
record_acquisition() (simcraft.resources.resource.ResourceStats method)
record_completion() (simcraft.activities.activity.ActivityStats method)
record_departure() (simcraft.activities.activity.ActivityStats method)
record_entry() (simcraft.activities.activity.ActivityStats method)
(simcraft.resources.queue.QueueStats method)
record_exit() (simcraft.resources.queue.QueueStats method)
record_release() (simcraft.resources.resource.ResourceStats method)
record_start() (simcraft.activities.activity.ActivityStats method)
record_state_change() (simcraft.resources.server.ServerStats method)
release() (simcraft.core.entity.EntityPool method)
(simcraft.Resource method)
(simcraft.ResourcePool method)
(simcraft.resources.resource.PreemptiveResource method)
(simcraft.statistics.time_series.CapacityTimeSeries method)
releases (simcraft.resources.resource.ResourceStats attribute)
,
[1]
remove() (simcraft.core.event.EventList method)
(simcraft.Queue method)
(simcraft.resources.queue.PriorityQueue method)
remove_resource() (simcraft.ResourcePool method)
ReplayBuffer (class in simcraft.optimization.rl_interface)
replications (simcraft.optimization.base.EvaluationResult attribute)
,
[1]
(simcraft.utils.config.SimulationConfig attribute)
,
[1]
report() (simcraft.Monitor method)
request() (simcraft.Resource method)
(simcraft.ResourcePool method)
request_to_start() (simcraft.activities.activity.Activity method)
(simcraft.activities.activity.ParallelActivity method)
reset() (simcraft.core.clock.Clock method)
(simcraft.Counter method)
(simcraft.Monitor method)
(simcraft.optimization.rl_interface.RLEnvironment method)
(simcraft.optimization.rl_interface.RLInterface method)
(simcraft.random.streams.CommonRandomNumbers method)
(simcraft.resources.queue.QueueStats method)
(simcraft.resources.resource.ResourceStats method)
(simcraft.resources.server.ServerStats method)
(simcraft.Simulation method)
(simcraft.statistics.counter.WindowedCounter method)
(simcraft.statistics.tally.BatchTally method)
(simcraft.Tally method)
(simcraft.TimeSeries method)
reset_all() (simcraft.random.streams.StreamManager method)
reset_stats() (simcraft.activities.activity.Activity method)
(simcraft.Queue method)
(simcraft.Resource method)
(simcraft.ResourcePool method)
(simcraft.Server method)
Resource (class in simcraft)
resource (simcraft.resources.pool.PooledResource attribute)
,
[1]
ResourcePool (class in simcraft)
ResourceState (class in simcraft.resources.resource)
ResourceStats (class in simcraft.resources.resource)
restart() (simcraft.Resource method)
(simcraft.Server method)
restore() (simcraft.random.streams.RandomStream method)
(simcraft.random.streams.StreamManager method)
results (simcraft.optimization.base.SimulationExperiment property)
reward (simcraft.optimization.rl_interface.Transition attribute)
,
[1]
RLEnvironment (class in simcraft.optimization.rl_interface)
RLInterface (class in simcraft.optimization.rl_interface)
rng (simcraft.Simulation property)
root (simcraft.Simulation property)
ROUND_ROBIN (simcraft.resources.pool.PoolSelectionPolicy attribute)
run() (simcraft.Simulation method)
run_evaluation() (simcraft.optimization.base.SimulationExperiment method)
run_grid_search() (simcraft.optimization.base.SimulationExperiment method)
run_random_search() (simcraft.optimization.base.SimulationExperiment method)
RUNNING (simcraft.core.simulation.SimulationState attribute)
S
sample() (simcraft.optimization.rl_interface.ReplayBuffer method)
(simcraft.RandomGenerator method)
sample_batch() (simcraft.optimization.rl_interface.ReplayBuffer method)
save() (simcraft.utils.config.ConfigLoader static method)
(simcraft.utils.config.YAMLConfig method)
save_checkpoint() (simcraft.random.streams.CommonRandomNumbers method)
schedule() (simcraft.Simulation method)
scheduled_time (simcraft.core.event.Event attribute)
,
[1]
SECONDS (simcraft.core.clock.TimeUnit attribute)
seed (simcraft.core.simulation.SimulationConfig attribute)
,
[1]
(simcraft.RandomGenerator property)
(simcraft.utils.config.SimulationConfig attribute)
,
[1]
Server (class in simcraft)
ServerState (class in simcraft.resources.server)
ServerStats (class in simcraft.resources.server)
service_time() (simcraft.RandomGenerator method)
set_attribute() (simcraft.Entity method)
set_base_seed() (simcraft.random.streams.StreamManager method)
set_level() (simcraft.utils.logging.SimulationLogger method)
set_seed() (simcraft.RandomGenerator method)
set_selection_policy() (simcraft.ResourcePool method)
set_shared_state() (simcraft.optimization.rl_interface.MultiAgentInterface method)
set_state() (simcraft.RandomGenerator method)
set_warmup() (simcraft.core.clock.Clock method)
setup_logging() (in module simcraft.utils.logging)
shape (simcraft.optimization.rl_interface.ActionSpace attribute)
,
[1]
(simcraft.optimization.rl_interface.StateSpace attribute)
,
[1]
shuffle() (simcraft.RandomGenerator method)
shuffled() (simcraft.RandomGenerator method)
shutdown() (simcraft.Resource method)
(simcraft.Server method)
Simulation (class in simcraft)
simulation_time (simcraft.optimization.base.EvaluationResult attribute)
,
[1]
SimulationConfig (class in simcraft.core.simulation)
(class in simcraft.utils.config)
SimulationExperiment (class in simcraft.optimization.base)
SimulationLogger (class in simcraft.utils.logging)
SimulationObjective (class in simcraft.optimization.base)
SimulationRecorder (class in simcraft.statistics.monitor)
SimulationState (class in simcraft.core.simulation)
size (simcraft.optimization.rl_interface.ReplayBuffer property)
(simcraft.ResourcePool property)
source (simcraft.activities.state_machine.Transition attribute)
,
[1]
start() (simcraft.statistics.monitor.SimulationRecorder method)
start_datetime (simcraft.core.clock.Clock attribute)
,
[1]
State (class in simcraft.activities.state_machine)
state (simcraft.Entity attribute)
,
[1]
(simcraft.optimization.rl_interface.Transition attribute)
,
[1]
(simcraft.random.distributions.LCG property)
(simcraft.Server property)
(simcraft.Simulation property)
StateMachine (class in simcraft.activities.state_machine)
StateMachineInstance (class in simcraft.activities.state_machine)
states (simcraft.activities.state_machine.StateMachine property)
StateSpace (class in simcraft.optimization.rl_interface)
stats (simcraft.activities.activity.Activity property)
(simcraft.Queue property)
(simcraft.Resource property)
(simcraft.ResourcePool property)
(simcraft.resources.queue.PriorityQueue property)
(simcraft.Server property)
std (simcraft.Tally property)
step() (simcraft.optimization.rl_interface.RLEnvironment method)
(simcraft.Simulation method)
stop() (simcraft.statistics.monitor.SimulationRecorder method)
stream_names (simcraft.random.streams.StreamManager property)
StreamManager (class in simcraft.random.streams)
success_rate (simcraft.resources.pool.PoolStats property)
sum (simcraft.Tally property)
summary() (simcraft.Tally method)
(simcraft.TimeSeries method)
T
tag (simcraft.core.event.Event attribute)
,
[1]
tallies (simcraft.Monitor property)
Tally (class in simcraft)
target (simcraft.activities.state_machine.Transition attribute)
,
[1]
(simcraft.optimization.base.SimulationObjective attribute)
,
[1]
TERMINATED (simcraft.core.simulation.SimulationState attribute)
throughput_rate (simcraft.resources.server.ServerStats property)
time_series (simcraft.Monitor property)
time_unit (simcraft.core.clock.Clock attribute)
,
[1]
(simcraft.core.simulation.SimulationConfig attribute)
,
[1]
(simcraft.utils.config.SimulationConfig attribute)
,
[1]
timeouts (simcraft.resources.resource.ResourceStats attribute)
,
[1]
TimeSeries (class in simcraft)
TimeUnit (class in simcraft.core.clock)
to_dataframe() (simcraft.Monitor method)
(simcraft.statistics.monitor.SimulationRecorder method)
to_dict() (simcraft.optimization.base.EvaluationResult method)
(simcraft.utils.config.YAMLConfig method)
to_hours() (simcraft.core.clock.TimeUnit method)
to_json() (simcraft.Monitor method)
total_acquisitions (simcraft.resources.pool.PoolStats attribute)
,
[1]
total_busy_time (simcraft.resources.pool.PooledResource attribute)
,
[1]
(simcraft.resources.resource.ResourceStats attribute)
,
[1]
total_capacity (simcraft.activities.activity.ParallelActivity property)
total_count (simcraft.core.entity.EntityPool property)
total_idle_time (simcraft.resources.resource.ResourceStats attribute)
,
[1]
total_in_system (simcraft.Server property)
total_processing_time (simcraft.activities.activity.ActivityStats attribute)
,
[1]
total_releases (simcraft.resources.pool.PoolStats attribute)
,
[1]
total_service_time (simcraft.resources.server.ServerStats attribute)
total_wait_time (simcraft.activities.activity.ActivityStats attribute)
,
[1]
(simcraft.resources.pool.PoolStats attribute)
(simcraft.resources.queue.QueueStats attribute)
,
[1]
(simcraft.resources.resource.ResourceStats attribute)
Transition (class in simcraft.activities.state_machine)
(class in simcraft.optimization.rl_interface)
triangular() (simcraft.RandomGenerator method)
trigger (simcraft.activities.state_machine.Transition attribute)
,
[1]
trigger() (simcraft.activities.state_machine.StateMachineInstance method)
try_finish() (simcraft.activities.activity.Activity method)
try_start() (simcraft.activities.activity.Activity method)
type (simcraft.optimization.rl_interface.ActionSpace attribute)
,
[1]
U
uniform() (simcraft.random.distributions.LCG method)
(simcraft.RandomGenerator method)
update_priority() (simcraft.resources.queue.PriorityQueue method)
upper_bound (simcraft.optimization.base.Parameter attribute)
,
[1]
utilization (simcraft.resources.resource.ResourceStats property)
(simcraft.resources.server.ServerStats property)
(simcraft.statistics.time_series.CapacityTimeSeries property)
(simcraft.TimeSeries property)
V
validate() (simcraft.optimization.base.Parameter method)
value (simcraft.Counter property)
variance (simcraft.Tally property)
W
wait() (simcraft.Entity method)
WAITING (simcraft.core.entity.EntityState attribute)
waiting_count (simcraft.Resource property)
warmup (simcraft.utils.config.SimulationConfig attribute)
,
[1]
warmup() (simcraft.Simulation method)
warmup_duration (simcraft.core.simulation.SimulationConfig attribute)
,
[1]
warmup_end (simcraft.core.clock.Clock attribute)
,
[1]
warning() (simcraft.utils.logging.SimulationLogger method)
weibull() (simcraft.RandomGenerator method)
weight (simcraft.optimization.base.SimulationObjective attribute)
,
[1]
window_count (simcraft.statistics.counter.WindowedCounter property)
window_rate (simcraft.statistics.counter.WindowedCounter property)
window_size (simcraft.statistics.counter.WindowedCounter property)
WindowedCounter (class in simcraft.statistics.counter)
Y
YAMLConfig (class in simcraft.utils.config)