Leniax documentation

Leniax is a Lenia simulation library powered by JAX. It can efficiently simulate and render Lenia worlds and can also be used to search for creatures, initial conditions, kernels and growth functions. It is also fully differentiable!

For a quick introduction and short example snippets, see our README.

Quickstart

• Overview
• Installation
• Examples
• Experiments

Guided Tour

• Conway's game of life
• Running a simple simulation
• Running multiple initializations simulation
• Running multiple simulations
• Initialization search (TPU)
• Initialization search (GPU)
• Quality-Diversity search
• Learning a simulation parameters
• Neural Lenia
• Neural CA

Additional material

• The Leniax Philosophy
• How to Contribute

API reference

• leniax.core package
  • update()
  • get_potential_fft()
  • get_potential()
  • get_field()
  • weighted_sum()
  • weighted_mean()
• leniax.runner package
  • run()
  • run_scan()
  • run_scan_mem_optimized()
  • run_scan_mem_optimized_pmap()
• leniax.growth_functions package
  • poly_quad4()
  • gaussian()
  • gaussian_target()
  • step()
  • staircase()
  • triangle()
• leniax.kernels package
  • KernelMapping
  • raw()
  • circle_2d()
• leniax.kernel_functions package
  • poly_quad()
  • gauss_bump()
  • gauss()
  • step()
  • staircase()
  • triangle()
• leniax.statistics package
  • build_compute_stats_fn()
  • check_heuristics()
  • init_counters()
  • min_channel_mass_heuristic()
  • max_channel_mass_heuristic()
  • min_mass_heuristic()
  • max_mass_heuristic()
  • monotonic_heuristic()
  • mass_volume_heuristic()
  • stats_list_to_dict()
• leniax.helpers package
  • init()
  • create_init_cells()
  • init_and_run()
  • search_for_mutation()
  • search_for_init()
  • build_update_fn()
  • build_get_potential_fn()
  • build_get_field_fn()
  • dump_assets()
  • dump_last_frame()
  • dump_frame()
  • dump_viz_data()
  • plot_kernels()
• leniax.utils package
  • get_container()
  • update_config_v1_v2()
  • get_param()
  • set_param()
  • st2fracs2float()
  • merge_cells()
  • center_world()
  • crop_zero()
  • auto_center()
  • center_and_crop()
  • get_image()
  • plot_stats()
  • generate_beta_faces()
  • check_dir()
  • save_config()
  • print_config()
  • load_img()
  • set_log_level()
  • seed_everything()
  • get_needed_memory()
• leniax.loader package
  • make_array_compressible()
  • compress_array()
  • decompress_array()
  • decompress_array_gzip()
  • decompress_array_base64()
  • ch2val()
  • val2ch()
  • load_raw_cells()
• leniax.qd package
  • build_eval_lenia_config_mem_optimized_fn()
  • get_dynamic_args()
  • update_individuals()
  • run_qd_search()
  • load_qd_grid_and_config()
  • render_best()
  • render_found_lenia()
  • save_ccdf()
  • save_metrics()
  • save_heatmap()
  • save_parallel_axes_plot()
  • save_emitter_samples()
  • save_all()
• leniax.lenia package
  • LeniaIndividual
  • get_update_config()
  • linear_scale()
  • log_scale()
• leniax.video package
  • render_video()
  • render_gif()
  • render_qd_search()
• leniax.colormaps package
  • PerceptualGradientColormap