Skip to main content
Ctrl+K
 - Home
  • Welcome to Flatland

Getting started

  • Installing Flatland
  • Using RailEnv
  • Why Flatland?

Key concepts

  • Key Concepts

Environment

  • Environment
    • Environment and Transitions
    • Actions
    • Rewards
    • Agents and State Machine
    • Stochasticity
    • Unordered Close Following Agents
    • Flatland Graph Rail Env
  • Scenario Generation
    • Stations and Links Data Model
  • Observations
    • Provided Observations
    • Custom observations
  • Integrations
  • Policy Evaluation and Trajectories
  • Scenarios

Tutorials

  • Sequential Agent
  • Operations Research
  • Reinforcement Learning
    • RLlib
    • PettingZoo

Challenges

  • ECML 2026
    • Evaluation Metrics
    • Level Configurations
    • Generate environments for training
    • Post-competition Analysis
  • Flatland Benchmarks
  • Flatland 3
    • Make your first submission
    • Evaluation Metrics
    • Moving Flatland 2 code to Flatland 3 - Common changes
    • Testing Submissions Locally
    • Environment Configurations
  • AMLD 2021
    • Making a Submission
    • Evaluation Metrics
    • Environment Configurations
  • Neurips 2020
    • Making a Submission
    • Evaluation Metrics
    • Environment Configurations
    • FAQs
  • Challenge Solutions

Resources

  • Papers using Flatland
  • Videos on Youtube using Flatland
  • Community Projects
  • Travel Wise
    • Travel Wise Data Model

APIDOC

  • Flatland 4.3.0 API Reference
    • flatland package
      • flatland.callbacks package
        • flatland.callbacks.callbacks module
        • flatland.callbacks.generate_movie_callbacks module
      • flatland.core package
        • flatland.core.grid package
        • flatland.core.configuration_distance_map module
        • flatland.core.distance_map module
        • flatland.core.distance_map_walker module
        • flatland.core.effects_generator module
        • flatland.core.env module
        • flatland.core.env_observation_builder module
        • flatland.core.env_prediction_builder module
        • flatland.core.policy module
        • flatland.core.resource_map module
        • flatland.core.transition_map module
        • flatland.core.transitions module
      • flatland.env_generation package
        • flatland.env_generation.env_generator module
      • flatland.envs package
        • flatland.envs.graph package
        • flatland.envs.grid package
        • flatland.envs.step_utils package
        • flatland.envs.RailEnvPolicy module
        • flatland.envs.agent_chains module
        • flatland.envs.agent_utils module
        • flatland.envs.distance_map module
        • flatland.envs.fast_methods module
        • flatland.envs.flatland_envs_rail_env_utils module
        • flatland.envs.graph_rail_env module
        • flatland.envs.grid4_generators_utils module
        • flatland.envs.line_generators module
        • flatland.envs.malfunction_effects_generators module
        • flatland.envs.malfunction_generators module
        • flatland.envs.observations module
        • flatland.envs.observations_perturbed module
        • flatland.envs.persistence module
        • flatland.envs.predictions module
        • flatland.envs.rail_env module
        • flatland.envs.rail_env_action module
        • flatland.envs.rail_env_policies module
        • flatland.envs.rail_env_policy module
        • flatland.envs.rail_env_shortest_paths module
        • flatland.envs.rail_env_utils module
        • flatland.envs.rail_generators module
        • flatland.envs.rail_grid_transition_map module
        • flatland.envs.rail_trainrun_data_structures module
        • flatland.envs.record_steps_effects_generator module
        • flatland.envs.rewards module
        • flatland.envs.schedule_generators module
        • flatland.envs.stations_links module
        • flatland.envs.timetable_generators module
        • flatland.envs.timetable_utils module
      • flatland.evaluators package
        • flatland.evaluators.aicrowd_helpers module
        • flatland.evaluators.client module
        • flatland.evaluators.evaluator_callback module
        • flatland.evaluators.messages module
        • flatland.evaluators.service module
        • flatland.evaluators.trajectory_analysis module
        • flatland.evaluators.trajectory_evaluator module
        • flatland.evaluators.trajectory_grid_evaluator module
      • flatland.integrations package
        • flatland.integrations.interactiveai package
      • flatland.ml package
        • flatland.ml.observations package
        • flatland.ml.pettingzoo package
        • flatland.ml.ray package
        • flatland.ml.wrapped_rail_env module
      • flatland.png package
      • flatland.svg package
      • flatland.trajectories package
        • flatland.trajectories.policy_grid_runner module
        • flatland.trajectories.policy_runner module
        • flatland.trajectories.trajectories module
        • flatland.trajectories.trajectory_observation_callbacks module
        • flatland.trajectories.trajectory_snapshot_callbacks module
      • flatland.utils package
        • flatland.utils.Timer module
        • flatland.utils.cli_utils module
        • flatland.utils.editor module
        • flatland.utils.editor_controller module
        • flatland.utils.editor_interfaces module
        • flatland.utils.editor_model module
        • flatland.utils.editor_view module
        • flatland.utils.env_edit_utils module
        • flatland.utils.graphics_layer module
        • flatland.utils.graphics_pgl module
        • flatland.utils.graphics_pil module
        • flatland.utils.jupyter_utils module
        • flatland.utils.misc module
        • flatland.utils.ordered_set module
        • flatland.utils.rendertools module
        • flatland.utils.seeding module
        • flatland.utils.simple_rail module
        • flatland.utils.svg module
      • flatland.cli module

Misc

  • Contributing
  • Credits
  • Repository
  • Suggest edit
  • Open issue
  • .rst

flatland.envs.stations_links module

Contents

  • Fibre
    • Fibre.edges
    • Fibre.from_pin
    • Fibre.to_pin
  • Gate
    • Gate.name
    • Gate.pins
  • Link
    • Link.fibres
    • Link.from_gate
    • Link.to_gate
  • Pin
    • Pin.name
    • Pin.node
  • Station
    • Station.edges
    • Station.gates
    • Station.name
    • Station.stopping_points
  • StationsLinks
    • StationsLinks.links
    • StationsLinks.stations
  • StoppingPoint
    • StoppingPoint.name
    • StoppingPoint.node

flatland.envs.stations_links module#

Data model stations and links, see https://flatland-association.github.io/flatland-book/environment/environment/stations_links.html Convention: use fully qualified names.

class flatland.envs.stations_links.Fibre(edges: List[Tuple[int, int]], from_pin: str, to_pin: str)[source]#

Bases: object

edges: List[Tuple[int, int]]#
from_pin: str#
to_pin: str#
class flatland.envs.stations_links.Gate(name: str, pins: Dict[int, flatland.envs.stations_links.Pin])[source]#

Bases: object

name: str#
pins: Dict[int, Pin]#
class flatland.envs.stations_links.Link(from_gate: str, to_gate: str, fibres: List[flatland.envs.stations_links.Fibre])[source]#

Bases: object

fibres: List[Fibre]#
from_gate: str#
to_gate: str#
class flatland.envs.stations_links.Pin(name: str, node: Tuple[int, int])[source]#

Bases: object

name: str#
node: Tuple[int, int]#
class flatland.envs.stations_links.Station(name: str, gates: Dict[str, flatland.envs.stations_links.Gate], stopping_points: List[flatland.envs.stations_links.StoppingPoint], edges: List[Tuple[int, int]])[source]#

Bases: object

edges: List[Tuple[int, int]]#
gates: Dict[str, Gate]#
name: str#
stopping_points: List[StoppingPoint]#
class flatland.envs.stations_links.StationsLinks(stations: Dict[str, flatland.envs.stations_links.Station], links: List[flatland.envs.stations_links.Link])[source]#

Bases: object

links: List[Link]#
stations: Dict[str, Station]#
class flatland.envs.stations_links.StoppingPoint(name: str, node: Tuple[int, int])[source]#

Bases: object

name: str#
node: Tuple[int, int]#

previous

flatland.envs.schedule_generators module

next

flatland.envs.timetable_generators module

Contents
  • Fibre
    • Fibre.edges
    • Fibre.from_pin
    • Fibre.to_pin
  • Gate
    • Gate.name
    • Gate.pins
  • Link
    • Link.fibres
    • Link.from_gate
    • Link.to_gate
  • Pin
    • Pin.name
    • Pin.node
  • Station
    • Station.edges
    • Station.gates
    • Station.name
    • Station.stopping_points
  • StationsLinks
    • StationsLinks.links
    • StationsLinks.stations
  • StoppingPoint
    • StoppingPoint.name
    • StoppingPoint.node

By The Flatland Community

© Copyright 2023.