template2d.py

# Name: NAME
# Dimensions: 2

# --- Set up executable path, do not edit ---
import sys
import inspect
import numpy as np
this_file_loc = (inspect.stack()[0][1])
main_dir_loc = this_file_loc[:this_file_loc.index('ca_descriptions')]
sys.path.append(main_dir_loc)
sys.path.append(main_dir_loc + 'capyle')
sys.path.append(main_dir_loc + 'capyle/ca')
sys.path.append(main_dir_loc + 'capyle/guicomponents')
# ---

from capyle.ca import Grid2D, Neighbourhood, randomise2d
import capyle.utils as utils


def setup(args):
    """Set up the config object used to interact with the GUI"""
    config_path = args[0]
    config = utils.load(config_path)
    # -- THE CA MUST BE RELOADED IN THE GUI IF ANY OF THE BELOW ARE CHANGED --
    config.title = "NAME"
    config.dimensions = 2
    config.wrap = False

    #burning states 1-4, non burning 5-8
    # 5 - Chapparral, 6 - Forest, 7 - Canyon, 8-Lake
    config.states = (0,1,2,3,4,5,6,7,8,9)

    # -------------------------------------------------------------------------

    # ---- Override the defaults below (these may be changed at anytime) ----

    config.state_colors = [(0,0,0),
    (0.379,0.586,0.926),(0.847,0.180,0.133),(0.800,0.090,0.047),(0.486,0.031,0.000),
    (0.923,0.957,0.259),(0.047,0.259,0.019),(0.820,0.816,0.812),(0.137,0.392,0.729),(0.379,0.586,0.926)]
    # config.grid_dims = (200,200)

    # ----------------------------------------------------------------------

    # the GUI calls this to pass the user defined config
    # into the main system with an extra argument
    # do not change
    if len(args) == 2:
        config.save()
        sys.exit()
    return config


def transition_function(grid, neighbourstates, neighbourcounts, decaygrid, firegrid):

    """Function to apply the transition rules
    and return the new grid"""
    cells_in_state_0 =(grid==0)
    cells_in_state_1 =(grid==1)
    cells_in_state_2 =(grid==2)
    cells_in_state_3 =(grid==3)
    cells_in_state_4 =(grid==4)

    burning_cells = (grid <= 4)

    unlitcells = (grid >= 5)
    cells_in_state_5 = (grid == 5) # cells that are currently in state 5
    cells_in_state_6 = (grid == 6) # cells that are currently in state 6
    cells_in_state_7 = (grid == 7) # cells that are currently in state 7
    cells_in_state_8 = (grid == 8) # cells that are currently in state 8

    burningNeighbours = (neighbourcounts[2]+neighbourcounts[3]+neighbourcounts[4])
    more_than_zero = (grid >= 0)
    NW, N, NE, W, E, SW, S, SE = neighbourstates
    southernNeighbours = (N <= 4)
    s = southernNeighbours & more_than_zero
    s_neighbours_of_lit_cells = unlitcells & s

    northernNeighbours = (S <= 4)
    n_neighbours_of_lit_cells = unlitcells & northernNeighbours

    easternNeighbours = (E<=4)
    e_neighbours_of_lit_cells = unlitcells & easternNeighbours

    westernNeighbours = (W<=4)
    w_neighbours_of_lit_cells = unlitcells & westernNeighbours

    firegridSize = np.shape(firegrid)
    (a,b)= firegridSize
    direction = "north"

    if direction == "north":
        firegrid[s_neighbours_of_lit_cells] *= 1.2
        firegrid[0,:]//=1.2
    elif direction == "south":
        firegrid[n_neighbours_of_lit_cells] *= 1.2
        firegrid[a-1,:]//=2.5

    elif direction == "west":
        firegrid[w_neighbours_of_lit_cells] *= 1.2
        firegrid[:,0]//=1.2
    elif direction == "east":
        firegrid[e_neighbours_of_lit_cells] *= 1.2
        firegrid[:,a-1]//=1.2

    print (firegrid)

#---------------------------------------------------------------------------------------------------
    #Transition function for Chapparral, Chapparral burns easily and stays on fire for a while
    #Chapparral burns with fewer neighbours, burns higher, and decays slower

    more_than_one_burning_neighbours = burningNeighbours >= 1
    less_than_five_burning_neighbours = burningNeighbours < 5
    chaparral_that_might_burn = more_than_one_burning_neighbours & less_than_five_burning_neighbours & cells_in_state_5
    #increase how likely it is to burn
    firegrid[chaparral_that_might_burn] += np.random.uniform(15,35,size=np.shape(firegrid[chaparral_that_might_burn]))

    burning_chaparral_neighbours = (burningNeighbours>5)
    chaparral_to_burning = cells_in_state_5 & burning_chaparral_neighbours
    firegrid[chaparral_to_burning]= 6000 #change Chapparral to the highest burn count

#---------------------------------------------------------------------------------------------------
    #Transition function for Dense forest, Dense forest doesnt ignite very easily but burns for a long time
    #if there are between 4 and 6 burning neighbours then increase the likelihood of it buring
    more_than_three_burning_neighbours = burningNeighbours >= 3
    less_than_six_burning_neighbours = burningNeighbours < 6
    forest_might_burn = more_than_three_burning_neighbours & less_than_six_burning_neighbours & cells_in_state_6
    #increase how likely it is to burn
    firegrid[forest_might_burn] += np.random.uniform(1,6, size = np.shape(firegrid[forest_might_burn]))
    #if there are more than 6 burning neighbours then set the forest on fire.
    burning_forest_neighbours = (burningNeighbours>6)
    forest_to_burning = cells_in_state_6 & burning_forest_neighbours
    firegrid[forest_to_burning] = 6000 #change forest burning

 #---------------------------------------------------------------------------------------------------
    #Transition function for canyon, burns very easily, only for a few hours
    #if the canyon has less than 4 buring neighbours and at least one then
    #increase likelihood of it burning
    has_a_burning_neighbour = burningNeighbours > 0 #more than 1 burning neighbour
    less_than_four_burning_neighbours = burningNeighbours > 4 #less than 4 burning neighbours
    canyon_might_burn = has_a_burning_neighbour & less_than_four_burning_neighbours & cells_in_state_7

    #increase likelhood of it burning
    firegrid[canyon_might_burn] += np.random.uniform(25,60, size = np.shape(firegrid[canyon_might_burn]))
    #if a canyon has more than 4 burning neighbours
    burning_canyon_neighbours = (burningNeighbours>4)
    canyon_to_burning = cells_in_state_7 & burning_canyon_neighbours
    firegrid[canyon_to_burning]= 6000
#------------------------------------------------------------------------------------------------------

    #Transition function for burning cells
    #when the water (state 1 ) hits the burning cell then extinguish it

    one_water_neighbour = (neighbourcounts[9] >0)
    burning_cells_to_be_extinguished = one_water_neighbour & burning_cells
    grid[burning_cells_to_be_extinguished] = 0

#-----DEFINING WHEN TO DECAY AND BURN CELLS --------------------------------------------------------------
    decaygrid[cells_in_state_2] -= np.random.uniform(40,110, size = np.shape(decaygrid[cells_in_state_2]))

    decaygrid[cells_in_state_3] -= np.random.uniform(5,6, size = np.shape(decaygrid[cells_in_state_3]))

    decaygrid[cells_in_state_4] -= np.random.uniform(500,1200, size=np.shape(decaygrid[cells_in_state_4]))

    #add decaygrid[cells_in_state_x] for all states to change the decay rates for different terrains
    reached_6000_burn = (firegrid >= 6000)

    chaparral_fire = reached_100_burn & cells_in_state_5
    grid[chaparral_fire] = 2

    forest_fire = reached_100_burn & cells_in_state_6
    grid[forest_fire] = 3

    canyon_fire = reached_100_burn & cells_in_state_7
    grid[canyon_fire] = 4
    decayed_to_one = (decaygrid <= 1)
    grid[decayed_to_one]= 0



    print(decaygrid)
    return grid


def main():
    """ Main function that sets up, runs and saves CA"""
    # Get the config object from set up
    config = setup(sys.argv[1:])
    # Create grid object using parameters from config + transition function
    decaygrid = np.zeros(config.grid_dims)

    decaygrid.fill(4000)
    firegrid = np.zeros(config.grid_dims)
    firegrid.fill(1)

    grid = Grid2D(config, (transition_function, decaygrid, firegrid))



    # Run the CA, save grid state every generation to timeline
    timeline = grid.run()

    # Save updated config to file
    config.save()
    # Save timeline to file
    utils.save(timeline, config.timeline_path)

if __name__ == "__main__":
    main()