replica
/
firesim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
firesim/docs/index.rst

68 lines
1.8 KiB
ReStructuredText
Raw Normal View History

Check that FireSim is running on tagged branch (#931) * Check for tagged release in build-setup * Bump CI to work with tag validate * Autogen tag for docs | Misc. updates * Forgot a n * [ci skip] update comments * Small update to comment [ci skip]
2022-02-15 11:38:40 +08:00
Welcome to FireSim's documentation (version "|version|")!
===========================================================
New squashed FireSim repo for open-sourcing This is the new FireSim repo that will be open-sourced. This commit matches the state of the repo at commit 031132485840608f111e6c745d8140b5def6d857 of the original FireSim repo, which now lives at https://github.com/firesim/firesim-prerelease All future FireSim development will happen in this repository. The FireSim pre-release repo is maintained privately only for archival purposes (e.g. if someone needs to do git blame on a file) - no new commits should be made on the pre-release repo.
2018-05-14 03:40:34 +08:00
guide users to the right place off the landing page
2018-05-19 07:34:20 +08:00
New to FireSim? Jump to the :ref:`firesim-basics` page for more info.
Doc. Rework [ci skip]
2023-05-05 15:16:46 +08:00
New squashed FireSim repo for open-sourcing This is the new FireSim repo that will be open-sourced. This commit matches the state of the repo at commit 031132485840608f111e6c745d8140b5def6d857 of the original FireSim repo, which now lives at https://github.com/firesim/firesim-prerelease All future FireSim development will happen in this repository. The FireSim pre-release repo is maintained privately only for archival purposes (e.g. if someone needs to do git blame on a file) - no new commits should be made on the pre-release repo.
2018-05-14 03:40:34 +08:00
.. toctree::
:maxdepth: 3
more documentation
2018-05-17 04:10:31 +08:00
:caption: Getting Started:
New squashed FireSim repo for open-sourcing This is the new FireSim repo that will be open-sourced. This commit matches the state of the repo at commit 031132485840608f111e6c745d8140b5def6d857 of the original FireSim repo, which now lives at https://github.com/firesim/firesim-prerelease All future FireSim development will happen in this repository. The FireSim pre-release repo is maintained privately only for archival purposes (e.g. if someone needs to do git blame on a file) - no new commits should be made on the pre-release repo.
2018-05-14 03:40:34 +08:00
FireSim-Basics
wip
2023-06-06 13:04:46 +08:00
Getting-Started-Guides/AWS-EC2-F1-Getting-Started/index
Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Xilinx-Alveo-U250-FPGAs
Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Xilinx-Alveo-U280-FPGAs
fix index
2023-06-29 00:05:56 +08:00
Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Xilinx-VCU118-FPGAs
Getting-Started-Guides/On-Premises-FPGA-Getting-Started/RHS-Research-Nitefury-II-FPGAs
wip
2023-06-06 13:04:46 +08:00
Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Xilinx-Vitis-FPGAs
New U250 FPGA tutorial
2023-03-05 09:51:05 +08:00
more documentation
2018-05-17 04:10:31 +08:00
.. toctree::
:maxdepth: 3
:caption: Advanced Docs:
some restructuring
2018-05-19 15:09:24 +08:00
Advanced-Usage/Manager/index
more restructuring
2018-05-19 15:14:29 +08:00
Advanced-Usage/Workloads/index
[Docs] Describe how to generate different targets; BOOM
2018-07-10 09:34:06 +08:00
Advanced-Usage/Generating-Different-Targets.rst
restructure the debugging section
2020-02-09 06:24:08 +08:00
Advanced-Usage/Debugging-in-Software/index
Advanced-Usage/Debugging-and-Profiling-on-FPGA/index
use conda in machine-launch-script.sh conda is linux distro agnostic (provided that you are using glibc newer than what the packages are built with, currently centos6-7) conda also enables non-root users to install prereqs using ./scripts/machine-launch-script.sh --prefix $HOME/conda conda also encapsulates dependencies and enables you to test new versions of things with: * edit dependencies in script * ./scripts/machine-launch-script.sh --env trythis * conda activate trythis Co-authored-by: David Biancolin <biancolin@berkeley.edu> Co-authored-by: Abraham Gonzalez <abe.j.gonza@gmail.com>
2022-02-23 00:53:39 +08:00
Advanced-Usage/Conda.rst
more cleanup
2018-05-19 15:26:59 +08:00
Advanced-Usage/Supernode.rst
some restructuring
2018-05-19 15:09:24 +08:00
Advanced-Usage/Miscellaneous-Tips.rst
Added FAQ section
2018-09-29 11:58:23 +08:00
Advanced-Usage/FAQs.rst
more documentation
2018-05-17 04:10:31 +08:00
[docs] Add MIDAS overview & philosophy
2018-10-18 15:27:17 +08:00
.. toctree::
:maxdepth: 3
Use new file emission trait + makefile naming cleanup
2021-07-03 07:13:38 +08:00
:caption: Compiler (Golden Gate) Docs:
[docs] Add MIDAS overview & philosophy
2018-10-18 15:27:17 +08:00
More brain dump
2019-09-27 03:48:34 +08:00
Golden-Gate/Overview
Golden-Gate/LI-BDN
wip
2019-10-05 06:36:22 +08:00
Golden-Gate/Bridges
[docs] Add a UARTBridge Walkthrough
2020-01-23 02:53:58 +08:00
Golden-Gate/Bridge-Walkthrough
[docs] First-pass Trigger system documentation
2020-03-28 12:10:52 +08:00
Golden-Gate/Triggers
[docs] Add section on Golden Gate resource optimizations
2020-10-01 02:48:27 +08:00
Golden-Gate/Resource-Optimizations
Use new file emission trait + makefile naming cleanup
2021-07-03 07:13:38 +08:00
Golden-Gate/Output-Files
[docs] Add MIDAS overview & philosophy
2018-10-18 15:27:17 +08:00
Add a Developer Section to docs.fires.im (#1004) This includes: * An FPGA-level metasimulation section * A description of available tests for Driver and Scala dev
2022-04-05 02:33:00 +08:00
.. toctree::
:maxdepth: 3
:caption: Developer Docs:
Developer-Docs/GoldenGate-and-Driver-Development
Developer-Docs/Host-Platform-Debugging
docs: Add a section on using VSCode Co-authored-by: Abraham Gonzalez <abe.j.gonza@gmail.com>
2022-05-12 04:28:17 +08:00
Developer-Docs/VSCode-Integration
Fix doc build
2022-09-16 02:55:01 +08:00
Developer-Docs/Managing-Conda-Lock-File
Address comments
2022-10-20 02:15:05 +08:00
Developer-Docs/Manager-Development
Add a Developer Section to docs.fires.im (#1004) This includes: * An FPGA-level metasimulation section * A description of available tests for Driver and Scala dev
2022-04-05 02:33:00 +08:00
Update documentation
2022-04-15 03:04:00 +08:00
.. toctree::
:maxdepth: 3
:caption: Miscellaneous:
External-Tutorial-Setup
New squashed FireSim repo for open-sourcing This is the new FireSim repo that will be open-sourced. This commit matches the state of the repo at commit 031132485840608f111e6c745d8140b5def6d857 of the original FireSim repo, which now lives at https://github.com/firesim/firesim-prerelease All future FireSim development will happen in this repository. The FireSim pre-release repo is maintained privately only for archival purposes (e.g. if someone needs to do git blame on a file) - no new commits should be made on the pre-release repo.
2018-05-14 03:40:34 +08:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`