run.py

# --------------------------------------------------------------------------------------------------
# Copyright (c) Sebastian Hellgren. All rights reserved.
# --------------------------------------------------------------------------------------------------

import sys
from pathlib import Path



# Do PYTHONPATH insert() instead of append() to prefer any local repo checkout over any pip install
REPO_ROOT = Path(__file__).parent.resolve()
TSFPGA_PATH = REPO_ROOT / "tsfpga"
VUNIT_PATH = REPO_ROOT / "vunit"
HDL_REGISTERS_PATH = REPO_ROOT / "vunit"
sys.path.insert(0, str(TSFPGA_PATH))
sys.path.insert(0, str(VUNIT_PATH))
sys.path.insert(0, str(HDL_REGISTERS_PATH))

from tsfpga.examples.simulation_utils import create_vhdl_ls_configuration
from tsfpga.examples.example_env import get_hdl_modules

OUTPUT_PATH = REPO_ROOT / "out"

# First party libraries
from tsfpga.examples.simulation_utils import (
    SimulationProject,
    get_arguments_cli,
)
from tsfpga.module import get_modules

def main():
    """
    Main function for the simulation flow. If you are setting up a new simulation environment
    you probably want to copy and modify this function. The other functions and classes
    should be reusable in most cases.
    """
    cli = get_arguments_cli(default_output_path=OUTPUT_PATH)
    args = cli.parse_args()
    
    module_names_avoid = set(["hard_fifo"]) if args.vivado_skip else None

    modules = get_modules(modules_folder=REPO_ROOT / "modules")
    modules_no_sim = get_modules(modules_folder= REPO_ROOT / "hdl-modules" / "modules", names_avoid=module_names_avoid)
    
    simulation_project = SimulationProject(args=args, enable_preprocessing=True)
    simulation_project.add_modules(args=args, modules=modules, modules_no_sim=modules_no_sim)
    
    if not args.vivado_skip:
        simulation_project.add_vivado_simlib()
        
    create_vhdl_ls_configuration(
        output_path=REPO_ROOT,
        temp_files_path=REPO_ROOT / "out",
        modules=modules,
    )

    simulation_project.vunit_proj.main()


if __name__ == "__main__":
    main()