{"id":22753746,"url":"https://github.com/slaclab/surf-tutorial","last_synced_at":"2025-07-31T02:07:34.810Z","repository":{"id":227723261,"uuid":"770648326","full_name":"slaclab/surf-tutorial","owner":"slaclab","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-17T17:42:59.000Z","size":227,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-24T05:43:40.608Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"VHDL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slaclab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-11T22:59:44.000Z","updated_at":"2025-03-23T03:07:29.000Z","dependencies_parsed_at":"2024-03-14T21:34:10.094Z","dependency_job_id":"ab45e66e-c034-4af2-bec4-fca819812d9b","html_url":"https://github.com/slaclab/surf-tutorial","commit_stats":null,"previous_names":["slaclab/surf-tutorial"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fsurf-tutorial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fsurf-tutorial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fsurf-tutorial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fsurf-tutorial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slaclab","download_url":"https://codeload.github.com/slaclab/surf-tutorial/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250573299,"owners_count":21452342,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-11T06:12:59.981Z","updated_at":"2025-04-24T05:43:45.406Z","avatar_url":"https://github.com/slaclab.png","language":"VHDL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# surf-tutorial\n\nThis tutorial is designed for users learning how to use SURF framework.\nEverything in this tutorial is `open source`!!!\nSo there are no \"pay barriers\" or licensing required to get started.\n\n\u003c!--- ######################################################## --\u003e\n\n# Clone the GIT repository\n\nInstall git large filesystems (git-lfs) in your .gitconfig (1-time step per unix environment)\n```bash\n$ git lfs install\n```\n\nClone the git repo with git-lfs enabled\n```bash\n$ git clone --recursive https://github.com/slaclab/surf-tutorial.git\n```\n\nNote: `recursive flag` used to initialize all submodules within the clone\n\n\u003c!--- ######################################################## --\u003e\n\n# System Requirements\n\nThere are two methods for running this tutorial:\n- system install of the required tools\n- Run in a docker container\n\n### System Install Method\n\nIt is recommend to use Ubuntu 2022.04 LTS (or later Ubuntu release) for these labs:\n\nHere are the Unix packages to install:\n```bash\n# Install the apt packages\nsudo apt install \\\n   python3 \\\n   python3-dev \\\n   python3-pip \\\n   git \\\n   git-lfs \\\n   build-essential \\\n   tclsh \\\n   gtkwave \\\n   ghdl \\\n   locales\n```\n\n### Python Virtual Environment\nA Python virtual environemnt is recommended to preserve system flexibility.\n```bash\n# Create a virtual environment called surf-venv\npython3 -m venv surf-venv\n\n# Activate the virtual environment\n./surf-venv/bin/activate\n\n# Upgrade pip\npip install --upgrade pip\n\n# Install the required python packages in the virtual environment\npython3 -m pip install -r ../surf-tutorial/pip_requirements.txt \n\n# Deactivate with\ndeactivate\n\n```\n\nIf you don't want to use a Python virtual environment, you can install the Python packages to your system with:\n```bash\nsudo pip install -r requirements.txt\n``` \n\n\n### Docker Container Method\n\nPlease refer to the [docker README.md](https://github.com/slaclab/surf-tutorial/blob/main/docker/README.md)\n\n\n\u003c!--- ######################################################## --\u003e\n\n# Summary of SURF Tutorial labs\n\nThis project provides different labs to help users get familiar with the SURF framework\n\n- `labs/01-AXI-Lite_register_endpoint`: demonstrates how to use the SURF AXI-Lite helper function procedures to quickly make an endpoint\n- `labs/02-AXI-stream_module`: demonstrates how to use the SURF's AXI stream frame work for both a sourcing and sinking a stream\n\nThe intent of this repo is to add more labs in the future.  Feel free to reach out and make requests. \n\n\u003c!--- ######################################################## --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslaclab%2Fsurf-tutorial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslaclab%2Fsurf-tutorial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslaclab%2Fsurf-tutorial/lists"}