Simulator and Digital Twin of an Automatic Warehouse

PyPI | GitHub | Issues

Overview

Welcome to the Simulator Automatic Warehouse documentation!

The Simulator Automatic Warehouse is a Python library that provides two main functions: a digital twin of an automatic warehouse and a simulator of an automatic warehouse.

The following code shows a basic example of creating a warehouse, creating a simulation environment and running a simulation.

from automatic_warehouse.warehouse import Warehouse
from automatic_warehouse.simulation.simulation_type.warehouse_simulation import WarehouseSimulation

# generate a Warehouse
warehouse = Warehouse()

# generate a simulation environment
simulation = WarehouseSimulation(warehouse)

# run the simulation
simulation.run_simulation()

# print the results
print(simulation.get_store_history_dataframe())

Table of Contents

• Overview
• Getting started
  • Introduction
    • What is an Automatic Warehouse?
    • How it was born
  • Installation
    • Dependencies
    • PyPI
    • Manual Installation
      • Download .whl from the release page
      • Build the project
      • Create and use a venv
    • Docker
• Step by step guide
  • Modelling process
  • Write the code
  • Run the simulator
• Concepts and Configuration
  • Concepts
    • Warehouse
    • Tray and Material
      • Tray
      • Material
    • Containers
      • Column
      • Carousel
    • Entries
      • Empty entry
      • Tray entry
  • Configuration
    • YAML file
      • General
      • Tray
      • Columns
      • Carousel
      • Simulation
    • Hardcoded
• Simulation results
  • How to instantiate
  • Count the total number of actions at a given time
  • Count the total number of a given action at a given time
  • Count the total amount of a given action in the whole simulation
  • Simulation time
• API Reference
  • Warehouse
    • Warehouse
      • Warehouse.add_column()
      • Warehouse.choice_random_tray()
      • Warehouse.cleanup()
      • Warehouse.cleanup_carousel()
      • Warehouse.cleanup_columns()
      • Warehouse.gen_rand()
      • Warehouse.get_carousel()
      • Warehouse.get_cols_container()
      • Warehouse.get_column()
      • Warehouse.get_def_space()
      • Warehouse.get_height()
      • Warehouse.get_max_height_material()
      • Warehouse.get_minimum_offset()
      • Warehouse.get_num_columns()
      • Warehouse.get_num_trays()
      • Warehouse.get_pos_y_floor()
      • Warehouse.get_speed_per_sec()
      • Warehouse.is_full()
      • Warehouse.pop_column()
      • Warehouse.remove_column()
      • Warehouse.set_pos_y_floor()
    • MinimumOffsetReturns
      • MinimumOffsetReturns.index
      • MinimumOffsetReturns.offset
  • Status Warehouse
    • Material and Tray
      • Material
        • Material
          • Material.get_barcode()
          • Material.get_height()
          • Material.get_length()
          • Material.get_name()
          • Material.get_width()
        • gen_rand_material()
        • gen_rand_materials()
        • random_name_materials
      • Tray
        • Tray
          • Tray.add_material()
          • Tray.add_materials()
          • Tray.get_best_offset_x()
          • Tray.get_best_y()
          • Tray.get_first_tray_entry()
          • Tray.get_height_limit()
          • Tray.get_items()
          • Tray.get_length()
          • Tray.get_max_height()
          • Tray.get_num_materials()
          • Tray.get_num_space_occupied()
          • Tray.get_width()
          • Tray.remove_material()
          • Tray.remove_materials()
          • Tray.set_best_offset_x()
          • Tray.set_best_y()
          • Tray.set_first_tray_entry()
        • gen_rand_tray()
        • gen_rand_trays()
    • Entries
      • Entry
        • Entry.get_offset_x()
        • Entry.get_pos_y()
      • EmptyEntry
      • TrayEntry
        • TrayEntry.add_tray()
        • TrayEntry.get_tray()
    • Containers
      • Containers abstract class
        • TrayContainer
          • TrayContainer.create_new_space()
          • TrayContainer.get_container()
          • TrayContainer.get_def_space()
          • TrayContainer.get_entries_occupied()
          • TrayContainer.get_height_container()
          • TrayContainer.get_height_warehouse()
          • TrayContainer.get_length()
          • TrayContainer.get_num_entries()
          • TrayContainer.get_num_entries_free()
          • TrayContainer.get_num_entries_occupied()
          • TrayContainer.get_num_materials()
          • TrayContainer.get_num_trays()
          • TrayContainer.get_offset_x()
          • TrayContainer.get_trays()
          • TrayContainer.get_warehouse()
          • TrayContainer.get_width()
          • TrayContainer.is_empty()
          • TrayContainer.is_full()
          • TrayContainer.reset_container()
          • TrayContainer.set_warehouse()
        • EnumContainer
      • Carousel
        • Carousel
          • Carousel.add_tray()
          • Carousel.get_bay()
          • Carousel.get_bay_entry()
          • Carousel.get_bay_tray()
          • Carousel.get_buffer()
          • Carousel.get_buffer_entry()
          • Carousel.get_buffer_tray()
          • Carousel.get_hole()
          • Carousel.get_num_entries_free()
          • Carousel.get_num_trays()
          • Carousel.is_bay_full()
          • Carousel.is_buffer_full()
          • Carousel.is_empty()
          • Carousel.is_full()
          • Carousel.remove_tray()
      • Column
        • Column
          • Column.add_tray()
          • Column.gen_materials_and_trays()
          • Column.get_height_last_position()
          • Column.get_num_entries_free()
          • Column.is_empty()
          • Column.is_full()
          • Column.last_position_is_occupied()
          • Column.remove_tray()
        • GenMaterialsAndTraysReturns
          • GenMaterialsAndTraysReturns.materials_inserted
          • GenMaterialsAndTraysReturns.trays_inserted
  • Configuration
    • Configuration class
      • WarehouseConfigurationSingleton
        • WarehouseConfigurationSingleton.get_configuration()
        • WarehouseConfigurationSingleton.get_instance()
        • WarehouseConfigurationSingleton.update_config()
        • WarehouseConfigurationSingleton.update_config_from_file()
    • Hardcoded configuration
      • WarehouseConfiguration
      • SimulationConfiguration
      • CarouselConfiguration
      • ColumnConfiguration
      • TrayConfiguration
    • Configuration validator
      • ConfigurationValidator
        • ConfigurationValidator.validate()
      • ConfigValidatorError
  • Simulation
    • Actions
      • The main 4 actions
        • Action
          • Action.get_env()
          • Action.get_simulation()
          • Action.get_warehouse()
          • Action.simulate_action()
        • ActionEnum
          • ActionEnum.EXTRACT_TRAY
          • ActionEnum.INSERT_RANDOM_MATERIAL
          • ActionEnum.REMOVE_RANDOM_MATERIAL
          • ActionEnum.SEND_BACK_TRAY
          • ActionEnum.from_str()
        • Buffer
          • Buffer.simulate_action()
        • InsertMaterial
          • InsertMaterial.get_duration()
          • InsertMaterial.simulate_action()
        • RemoveMaterial
          • RemoveMaterial.get_duration()
          • RemoveMaterial.simulate_action()
        • InsertRandomMaterial
          • InsertRandomMaterial.simulate_action()
        • RemoveRandomMaterial
          • RemoveRandomMaterial.simulate_action()
        • ExtractTray
          • ExtractTray.simulate_action()
        • SendBackTray
          • SendBackTray.simulate_action()
      • Basic movements
        • Move
          • Move.get_buffer()
          • Move.simulate_action()
        • GoToBay
          • GoToBay.simulate_action()
        • GoToBuffer
          • GoToBuffer.simulate_action()
        • Load
          • Load.simulate_action()
        • Unload
          • Unload.simulate_action()
        • Vertical
          • Vertical.simulate_action()
    • Types
      • Abstract simulation type class
        • Simulation
          • Simulation.get_environment()
          • Simulation.get_events_to_simulate()
          • Simulation.get_sim_num_actions()
          • Simulation.get_sim_time()
          • Simulation.get_store_history()
          • Simulation.get_store_history_dataframe()
          • Simulation.run_simulation()
      • Warehouse simulation type
        • WarehouseSimulation
          • WarehouseSimulation.allocate_best_pos()
          • WarehouseSimulation.get_res_bay()
          • WarehouseSimulation.get_res_buffer()
          • WarehouseSimulation.get_warehouse()
          • WarehouseSimulation.go_to_bay()
          • WarehouseSimulation.go_to_buffer()
          • WarehouseSimulation.horiz_move()
          • WarehouseSimulation.load()
          • WarehouseSimulation.load_in_carousel()
          • WarehouseSimulation.loading_buffer_and_remove()
          • WarehouseSimulation.new_simulation()
          • WarehouseSimulation.reach_tray_height()
          • WarehouseSimulation.run_simulation()
          • WarehouseSimulation.unload()
          • WarehouseSimulation.vertical_move()
  • Utils
    • Decide position algorithm
      • decide_position()
      • DecidePositionReturns
        • DecidePositionReturns.column
        • DecidePositionReturns.index
      • Algorithm
        • Algorithm.HIGH_POSITION
    • Statistics
      • WarehouseStatistics
        • WarehouseStatistics.action_completed_every()
        • WarehouseStatistics.action_finished_every()
        • WarehouseStatistics.action_started_every()
        • WarehouseStatistics.actions_completed_every()
        • WarehouseStatistics.actions_finished_every()
        • WarehouseStatistics.actions_started_every()
        • WarehouseStatistics.count_action_completed()
        • WarehouseStatistics.finish_time_simulation()
        • WarehouseStatistics.start_time_simulation()
        • WarehouseStatistics.total_simulation_time()
      • TimeEnum
        • TimeEnum.BUSINESS_DAY
        • TimeEnum.DAY
        • TimeEnum.HOUR
        • TimeEnum.MICROSECOND
        • TimeEnum.MILLISECOND
        • TimeEnum.MINUTE
        • TimeEnum.MONTH
        • TimeEnum.NANOSECOND
        • TimeEnum.SECOND
        • TimeEnum.YEAR