TODOs
This list is assembled from throughout the documentation. If you’re looking for something to keep yourself busy, this is a good place to start.
Note
This list only includes TODOs formatted in a way that Sphinx understands.
There are likely others formatted as comments throughout the code which don’t
appear listed here. grep can help you find them!
The test and qualification folders are not pulled in by Sphinx, and
so any TODOs there will also not be included in this list.
Todo
Make the request’s fail replies more informative in the case of malformed requests.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/katgpucbf/envs/latest/lib/python3.12/site-packages/katgpucbf/fgpu/engine.py:docstring of katgpucbf.fgpu.engine.FEngine.request_delays, line 3.)
Todo
Eventually modify the classes to support 4 and 16 bit input samples. The kernel supports this, but it is not exposed to the reader. There is no use case for this at the moment, so this is a low priority.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/katgpucbf/envs/latest/lib/python3.12/site-packages/katgpucbf/xbgpu/correlation.py:docstring of katgpucbf.xbgpu.correlation, line 3.)
Todo
A lot of the sensors are common to both the F- and X-engines. It may be worth investigating some kind of abstract base class for engines to build on top of.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/katgpucbf/envs/latest/lib/python3.12/site-packages/katgpucbf/xbgpu/engine.py:docstring of katgpucbf.xbgpu.engine.XBEngine, line 18.)
Todo
Checks need to be put in place to ensure the command line parameters are correct:
Is the port number valid, is the IP address a multicast address, is the array size >0, etc.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/katgpucbf/envs/latest/lib/python3.12/site-packages/katgpucbf/xbgpu/main.py:docstring of katgpucbf.xbgpu.main, line 7.)
Todo
NGC-730
Add comments on the scripts themselves to make them easier to follow.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/katgpucbf/checkouts/latest/doc/control.rst, line 121.)
Todo
NGC-730
Update run-{dsim, fsim, fpgu, xbgpu}.sh scripts to standardise over usage
of either numactl or taskset.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/katgpucbf/checkouts/latest/doc/control.rst, line 174.)
Todo
If this section gets to be too large, it can probably also make its way into its own file.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/katgpucbf/checkouts/latest/doc/data_interfaces.rst, line 4.)
Todo
NGC-680
- Relationship with katsdpcontroller
- reference to a later section which will describe it more thoroughly.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/katgpucbf/checkouts/latest/doc/introduction.rst, line 93.)
Todo
Add a diagram here
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/katgpucbf/checkouts/latest/doc/signal_path.rst, line 360.)