Alpyne

An connector library for running AnyLogic models exported from the RL experiment in a Python environment.

General

• Getting started
  • Installation
  • Preparing an AnyLogic model
  • Next Steps
• Components of an RL-ready model
  • Filling out the RL experiment
  • About the takeAction method
  • About the optional “mode” parameter
• High-level walkthrough
  • Creating the AnyLogicSim object
    • model path argument
    • logging
    • locking
    • engine settings
    • automatic finish
  • Resetting the run
  • Submitting actions
  • Experiment status + observation
  • Retrieving outputs
  • Training an AI policy
  • Testing a policy within the AnyLogic model
  • Complete sample code

Technical

• API Docs
  • alpyne.sim
    • AnyLogicSim
      • AnyLogicSim.schema
      • AnyLogicSim.reset()
      • AnyLogicSim.take_action()
      • AnyLogicSim.observation()
      • AnyLogicSim.status()
      • AnyLogicSim._engine()
      • AnyLogicSim.lock()
      • AnyLogicSim.outputs()
  • alpyne.data
    • SimConfiguration
    • SimObservation
    • SimAction
    • SimStatus
    • EngineStatus
    • FieldData
    • SimSchema
    • EngineSettings
      • EngineSettings.stop_time
      • EngineSettings.stop_date
  • alpyne.outputs
    • StatisticsDiscrete
    • StatisticsContinuous
    • DataSet
    • HistogramSmartData
    • HistogramSimpleData
    • Histogram2DData
    • AmountUnits
      • AmountUnits.LITER
      • AmountUnits.OIL_BARREL
      • AmountUnits.CUBIC_METER
      • AmountUnits.KILOGRAM
      • AmountUnits.TON
    • TimeUnits
      • TimeUnits.MILLISECOND
      • TimeUnits.SECOND
      • TimeUnits.MINUTE
      • TimeUnits.HOUR
      • TimeUnits.DAY
      • TimeUnits.WEEK
      • TimeUnits.MONTH
      • TimeUnits.YEAR
    • LengthUnits
      • LengthUnits.MILLIMETER
      • LengthUnits.CENTIMETER
      • LengthUnits.METER
      • LengthUnits.KILOMETER
      • LengthUnits.INCH
      • LengthUnits.FOOT
      • LengthUnits.YARD
      • LengthUnits.MILE
      • LengthUnits.NAUTICAL_MILE
    • AngleUnits
      • AngleUnits.TURN
      • AngleUnits.RADIAN
      • AngleUnits.DEGREE
    • AreaUnits
      • AreaUnits.SQ_MILLIMETER
      • AreaUnits.SQ_CENTIMETER
      • AreaUnits.SQ_METER
      • AreaUnits.SQ_KILOMETER
      • AreaUnits.SQ_INCH
      • AreaUnits.SQ_FOOT
      • AreaUnits.SQ_YARD
      • AreaUnits.SQ_MILE
      • AreaUnits.SQ_NAUTICAL_MILE
    • RateUnits
      • RateUnits.PER_MILLISECOND
      • RateUnits.PER_SECOND
      • RateUnits.PER_MINUTE
      • RateUnits.PER_HOUR
      • RateUnits.PER_DAY
      • RateUnits.PER_WEEK
      • RateUnits.PER_MONTH
      • RateUnits.PER_YEAR
    • AccelerationUnits
      • AccelerationUnits.MPS_SQ
      • AccelerationUnits.FPS_SQ
    • SpeedUnits
      • SpeedUnits.MPS
      • SpeedUnits.KPH
      • SpeedUnits.FPS
      • SpeedUnits.FPM
      • SpeedUnits.MPH
      • SpeedUnits.KN
    • FlowRateUnits
      • FlowRateUnits.LITER_PER_SECOND
      • FlowRateUnits.OIL_BARREL_PER_SECOND
      • FlowRateUnits.CUBIC_METER_PER_SECOND
      • FlowRateUnits.KILOGRAM_PER_SECOND
      • FlowRateUnits.TON_PER_SECOND
    • RotationSpeedUnits
      • RotationSpeedUnits.RPM
      • RotationSpeedUnits.RAD_PER_SECOND
      • RotationSpeedUnits.DEG_PER_SECOND
    • UnitValue
  • alpyne.constants
    • DATE_PATTERN_LOOKUP
    • TYPE_LOOKUP
    • JavaLogLevel
      • JavaLogLevel.SEVERE
      • JavaLogLevel.WARNING
      • JavaLogLevel.INFO
      • JavaLogLevel.CONFIG
      • JavaLogLevel.FINE
      • JavaLogLevel.FINER
      • JavaLogLevel.FINEST
    • EngineState
      • EngineState.IDLE
      • EngineState.PAUSED
      • EngineState.RUNNING
      • EngineState.FINISHED
      • EngineState.ERROR
      • EngineState.PLEASE_WAIT
  • alpyne.typing
    • EngineSettingKeys
    • Number
    • OutputType
  • alpyne.env
    • AlpyneEnv
      • AlpyneEnv.__init__()
      • AlpyneEnv._get_config()
      • AlpyneEnv._get_obs()
      • AlpyneEnv._to_action()
      • AlpyneEnv._get_info()
      • AlpyneEnv._is_terminal()
      • AlpyneEnv._is_truncated()
      • AlpyneEnv.reset()
      • AlpyneEnv.step()
    • make()
  • alpyne.utils
    • next_num()
    • AlpyneJSONEncoder
      • AlpyneJSONEncoder.default()
    • AlpyneJSONDecoder
      • AlpyneJSONDecoder.decode()
    • resolve_model_jar()
    • histogram_outputs_to_fake_dataset()
    • limit()
    • get_resources_path()
    • get_wildcard_paths()
    • shorten_by_relativeness()
• Event sequence in model creation process
• Order of events with the ‘takeAction’ function
  • Background information
  • Relevance to RL workflows
• Appendix
  • Locking

Indices and tables

• Index

• Module Index

• Search Page