Electronic System Design Group

Readme

FPGAFlow is a python script to handle a complete FPGA design flow where the design files, libraries and supplementary tools are stored in a source code repository.

See Installation for installation notes.

Adding Python Modules

When adding new python modules to: $REPO_ROOT/tools/fpgaflow/scripts/python/fpgaflow/Pipfile the pip requirements.txt must also be updated to ensure https://fpgaflow.readthedocs.io/en/latest/index.html automatic build can operate correctly. This can be achieved by running:

cd $REPO_ROOT/tools/fpgaflow/scripts/python/fpgaflow/
pipenv lock -r

and copying the output to: $REPO_ROOT/tools/fpgaflow/scripts/python/fpgaflow/requirements.txt

License

BSD © 2018-2019 Science and Technology Facilities Council & contributors

Index:

• Readme
  • Adding Python Modules
    • License
• Changelog
• Modules
  • helpers/arguments.py
  • helpers/customlogging.py
  • docflow.py
  • environmentsetup.py
  • fpgavendor_iface.py
  • helpers/funcs.py
  • projectmanager.py
  • setup.py
  • helpers/version.py
  • vunit_iface.py
• Arguments
  • Required
    • --config
    • --settings
  • Optional
    • --checkout_enabled
    • --headless
    • --skip_xml2vhdl
    • --open_gui
      • fpga
      • sim
    • --clean
      • all
      • fpga
      • ip
      • precompiled_sim
      • sim
• Configuration
  • Tag Substitution
  • Sections
    • repository:
      • required:
      • categories:
      • category_mapping:
      • lib_append_categories:
      • <CATEGORY>_layout:
    • contributors:
      • contrib_lib_list:
    • fpga:
      • supported_vendors:
      • <FPGA VENDOR>:
    • simulation:
      • supported_vendors:
      • <SIM TOOL VENDOR>:
      • xilinx:
      • altera:
    • vhdl:
    • documentation:
      • required:
      • supported_languages:
      • doxygen:
      • sphinx:
      • dot:
    • environment:
      • required:
      • exclude_keywords:
• EXCLUDE Files
• Installation
  • Prerequisites
    • Required Software
    • Python Modules
    • Additional Modules
    • Installed Tools
    • Required Environment Variables
    • Installation Instructions
    • Links
• Known Issues
• Directory Layouts
  • Root Directory Processing
  • First Level Directories
    • constraints
    • docs
    • netlists
    • scripts
    • settings
    • simulation
    • src
• Settings
  • Sections
    • <CATEGORY>:
      • name:
      • contrib_lib:
      • top_level:
      • top_level_tb_entity:
      • vendor:
      • family:
      • tool_version:
      • tool_mode:
      • device:
      • board_id:
      • board_timestamp_enabled:
      • board:
      • board_settings:
      • project_name_override:
      • sim_vendor:
      • sim_version:
      • sim_mode:
      • sim_init_script:
      • use_glbl:
    • vunit_args:
      • version:
      • list:
      • files:
      • log_level:
      • output_path:
      • test_patterns:
      • keep_compiling:
      • num_threads:
      • elaborate:
      • verbose:
      • xunit_xml:
      • coverage:
      • unique_sim:
      • exit_0:
      • no_color:
      • xunit_xml_format:
      • dont_catch_exceptions:
      • export_json:
      • with_attributes:
      • without_attributes:
      • compile:
      • fail_fast:
    • repository_config:
      • git:
      • subversion:
    • documentation:
      • project_title:
      • project_version:
      • project_author:
      • project_org:
      • project_release:
      • doxy_version:
      • dot_version:
      • sphinx_version:
      • image_path:
      • logo_path:
      • logo_name:
      • source_path:
      • language:
      • restricted_src:
      • doc_clean:
      • release_uri:
      • issue_uri:
      • releases_document_name:
      • doxy_mainpage:
• Utils
  • pipenv_installer.py
    • Creating Virtual Environment
    • Creating Virtual Environment with Additional Modules
    • Updating Additional Modules
• Vendor IP
  • Description
    • Configuration File
      • vendor_ip_layout:
      • <IPCAT>:
      • <IPSUBCAT>:
      • <NAME>:
    • Settings File
    • Common Wrapper Files
• VUnit Integration
  • Standard Libraries
  • Project IP Libraries

Indices and Tables:

• Index
• Module Index
• Search Page