Skip to content

added tut_intro model file, also made changes to the intro tutorial document #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Gmotion94 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

added tut_intro model file, also made changes to the intro tutorial document #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b5b746
added tut_intro model file, also made changes to the tutorial document
Gmotion94 Sep 22, 2022
538a7ad
attempting with git add of these files again
Gmotion94 Sep 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added alveo/tut_intro/au50_tut_intro.slx
View file
Open in desktop
Binary file not shown.
Binary file added docs/_static/img/au50/alveo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/au50/au50.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/au50/au50_.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/au50/ultra_scale.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinx_markdown_tables',
#'myst_parser',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -186,4 +187,4 @@
# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
todo_include_todos = True
71 changes: 40 additions & 31 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,18 @@ The tutorial repository can be found on `github <https://github.com/casper-astro

It is recommended to start with the introduction tutorial for the platform of your liking, then do that platform's GBE tutorial and finally move onto the spectrometer or correlator tutorial or the next difficulty tutorial.

Currently there are tutorials available for five hardware platforms within the CASPER community:

1. ROACH
2. ROACH2
3. SKARAB
4. SNAP
5. Red Pitaya

Environment setup
---------------------

The recommended OS is Ubuntu (currently 20.04) as it is what the majority of the collaboration are using. This makes it easier for us to support you. If you are so inclined, you could also use Red Hat, but we definitely do not support Windows. You are welcome to try but you will be on your own. You could always run Linux in a VM although this will increase your compile times.
The recommended OS is Ubuntu (currently 16.04) as it is what the majority of the collaboration are using. This makes it easier for us to support you. If you are so inclined, you could also use Red Hat, but we definitely do not support Windows. You are welcome to try but you will be on your own. You could always run Linux in a VM although this will increase your compile times.

The current compatibility matrix of software needed to run these tutorials is below:

Expand All @@ -21,23 +29,11 @@ The current compatibility matrix of software needed to run these tutorials is be
+================+=====================+====================+====================+=================================+===================+
|ROACH1/2 | Ubuntu 14.04 | 2013b | ISE 14.7 | branch: `roach` | Python 2.7 |
+----------------+---------------------+--------------------+--------------------+---------------------------------+-------------------+
|SKARAB | Ubuntu 20.04 | 2021a | Vivado 2021.1 | branch: `m2021a` | Python 3.8 |
+----------------+---------------------+--------------------+--------------------+---------------------------------+-------------------+
|SNAP | Ubuntu 20.04 | 2021a | Vivado 2021.1 | branch: `m2021a` | Python 3.8 |
+----------------+---------------------+--------------------+--------------------+---------------------------------+-------------------+
|Red Pitaya | Ubuntu 20.04 | 2021a | Vivado 2021.1 | branch: `m2021a` | Python 3.8 |
+----------------+---------------------+--------------------+--------------------+---------------------------------+-------------------+
|ZCU216 | Ubuntu 20.04 | 2021a | Vivado 2021.1 | branch: `m2021a` | Python 3.8 |
|SKARAB | Ubuntu 16.04 | 2018a | Vivado 2019.1.1 | branch: `master` | Python 3 |
+----------------+---------------------+--------------------+--------------------+---------------------------------+-------------------+
|ZCU208 | Ubuntu 20.04 | 2021a | Vivado 2021.1 | branch: `m2021a` | Python 3.8 |
|SNAP | Ubuntu 16.04 | 2018a | Vivado 2019.1.1 | branch: `master` | Python 3 |
+----------------+---------------------+--------------------+--------------------+---------------------------------+-------------------+
|ZCU111 | Ubuntu 20.04 | 2021a | Vivado 2021.1 | branch: `m2021a` | Python 3.8 |
+----------------+---------------------+--------------------+--------------------+---------------------------------+-------------------+
|PYNQ RFSoC 4x2 | Ubuntu 20.04 | 2021a | Vivado 2021.1 | branch: `m2021a` | Python 3.8 |
+----------------+---------------------+--------------------+--------------------+---------------------------------+-------------------+
|HTG ZRF16-29DR | Ubuntu 20.04 | 2021a | Vivado 2021.1 | branch: `m2021a` | Python 3.8 |
+----------------+---------------------+--------------------+--------------------+---------------------------------+-------------------+
|HTG ZRF16-49DR | Ubuntu 20.04 | 2021a | Vivado 2021.1 | branch: `m2021a` | Python 3.8 |
|Red Pitaya | Ubuntu 16.04 | 2018a | Vivado 2019.1.1 | branch: `master` | Python 3 |
+----------------+---------------------+--------------------+--------------------+---------------------------------+-------------------+

Instructions on setting up an environment in which to run these tutorials can be found `here <https://github.com/casper-astro/tutorials_devel/blob/workshop2019/README.md>`__. Instructions on setting up the toolflow-proper can be found `here <https://casper-toolflow.readthedocs.io/en/latest/index.html>`__.
Expand Down Expand Up @@ -73,10 +69,10 @@ Vivado

**SNAP**

1. Introduction Tutorial: :doc:`Step-by-Step <tutorials/snap/tut_intro>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/vivado/snap/tut_intro>`_
2. 10GbE Tutorial: :doc:`Step-by-Step <tutorials/snap/tut_ten_gbe>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/vivado/snap/tut_tge>`__
3. Spectrometer Tutorial :doc:`Step-by-Step <tutorials/snap/tut_spec>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/vivado/snap/tut_spec>`__
4. Correlator Tutorial :doc:`Step-by-Step <tutorials/snap/tut_corr>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/vivado/snap/tut_corr>`__
1. Introduction Tutorial: :doc:`Step-by-Step <tutorials/snap/tut_intro>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/vivado/snap/tut_intro>`_
2. 10GbE Tutorial: :doc:`Step-by-Step <tutorials/snap/tut_ten_gbe>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/vivado/snap/tut_tge>`__
3. Spectrometer Tutorial :doc:`Step-by-Step <tutorials/snap/tut_spec>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/vivado/snap/tut_spec>`__
4. Correlator Tutorial :doc:`Step-by-Step <tutorials/snap/tut_corr>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/vivado/snap/tut_corr>`__
5. Yellow Block Tutorial: :doc:`Bidirectional GPIO <tutorials/snap/tut_gpio_bidir>`

.. toctree::
Expand All @@ -92,10 +88,10 @@ Vivado

**SKARAB**

1. Introduction Tutorial :doc:`Step-by-Step <tutorials/skarab/tut_intro>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/skarab/tut_intro>`__
2. 40GbE Tutorial :doc:`Step-by-Step <tutorials/skarab/tut_40gbe>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/skarab/tut_40gbe>`__
3. HMC Tutorial :doc:`Step-by-Step <tutorials/skarab/tut_hmc>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/skarab/tut_hmc>`__
4. Spectrometer Tutorials :doc:`Step-by-Step <tutorials/skarab/tut_spec/tut_spec_index>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/skarab/tut_spec>`__
1. Introduction Tutorial :doc:`Step-by-Step <tutorials/skarab/tut_intro>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/skarab/tut_intro>`__
2. 40GbE Tutorial :doc:`Step-by-Step <tutorials/skarab/tut_40gbe>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/skarab/tut_40gbe>`__
3. HMC Tutorial :doc:`Step-by-Step <tutorials/skarab/tut_hmc>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/skarab/tut_hmc>`__
4. Spectrometer Tutorials :doc:`Step-by-Step <tutorials/skarab/tut_spec/tut_spec_index>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/skarab/tut_spec>`__
5. :doc:`ADC Synchronous Data Acquisition Tutorials <tutorials/skarab/tut_adc/tut_adc_index>`

.. toctree::
Expand All @@ -112,9 +108,9 @@ Vivado
**Red Pitaya**

1. :doc:`Guide to Setting Up Your New Red Pitaya <tutorials/redpitaya/red_pitaya_setup>`
2. Introduction Tutorial :doc:`Step-by-Step <tutorials/redpitaya/tut_intro>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/red_pitaya/tut_intro>`__
3. ADC and DAC Interface Tutorial :doc:`Step-by-Step <tutorials/redpitaya/tut_adc_dac>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/red_pitaya/tut_adc_dac>`__
4. Spectrometer Tutorial :doc:`Step-by-Step <tutorials/redpitaya/tut_spec>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/red_pitaya/tut_spec>`__
2. Introduction Tutorial :doc:`Step-by-Step <tutorials/redpitaya/tut_intro>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/red_pitaya/tut_intro>`__
3. ADC and DAC Interface Tutorial :doc:`Step-by-Step <tutorials/redpitaya/tut_adc_dac>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/red_pitaya/tut_adc_dac>`__
4. Spectrometer Tutorial :doc:`Step-by-Step <tutorials/redpitaya/tut_spec>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/red_pitaya/tut_spec>`__


.. toctree::
Expand All @@ -126,15 +122,28 @@ Vivado
tutorials/redpitaya/tut_intro
tutorials/redpitaya/tut_adc_dac
tutorials/redpitaya/tut_spec

**ALVEO**

1. Introduction Tutorial :doc:`Step-by-Step <tutorials/alveo/tut_intro>` or `Completed <https://github.com/Gmotion94/tutorials_devel/tree/docs_update/alveo/tut_intro>`__

.. toctree::
:maxdepth: 1
:hidden:
:caption: Alveo Tutorials

tutorials/alveo/tut_intro



**RFSOC**

1. :doc:`CASPER RFSOC README <tutorials/rfsoc/readme>`
2. :doc:`Getting Started With RFSoC <tutorials/rfsoc/tut_getting_started>`
3. RFSoC Platform Yellow Block and Simulink Overview :doc:`Step-by-Step <tutorials/rfsoc/tut_platform>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/rfsoc/tut_platform>`__
4. Using the RFDC :doc:`Step-by-Step <tutorials/rfsoc/tut_rfdc>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/rfsoc/tut_rfdc>`__
5. [Under Construction] Spectrometer Tutorial :doc:`Step-by-Step <tutorials/rfsoc/tut_spec>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/rfsoc/tut_spec>`__
6. [Under Construction] 100 Gigabit Ethernet :doc:`Step-by-Step <tutorials/rfsoc/tut_100g>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/main/rfsoc/tut_onehundred_gbe>`__
3. RFSoC Platform Yellow Block and Simulink Overview :doc:`Step-by-Step <tutorials/rfsoc/tut_platform>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/rfsoc/tut_platform>`__
4. Using the RFDC :doc:`Step-by-Step <tutorials/rfsoc/tut_rfdc>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/rfsoc/tut_rfdc>`__
5. [Under Construction] Spectrometer Tutorial :doc:`Step-by-Step <tutorials/rfsoc/tut_spec>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/rfsoc/tut_spec>`__
6. [Under Construction] 100 Gigabit Ethernet :doc:`Step-by-Step <tutorials/rfsoc/tut_100g>` or `Completed <https://github.com/casper-astro/tutorials_devel/tree/master/rfsoc/tut_onehundred_gbe>`__

.. toctree::
:maxdepth: 1
Expand Down
Loading