Skip to content

Commit

Permalink
Fix docs landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
spinicist committed Jan 10, 2024
1 parent df3915c commit e5d7d79
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 48 deletions.
12 changes: 0 additions & 12 deletions docs/contents.rst

This file was deleted.

40 changes: 29 additions & 11 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,41 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to RIESLING!
====================================
RIESLING
========

.. image:: riesling-logo.png
.. image:: ../riesling-logo.png
:alt: RIESLING Logo

RIESLING is a reconstruction toolbox tuned for 3D radial MRI - the name stands for Radial Interstices Enable Speedy Low-volume imagING - but it can process other trajectories as well.
Radial Interstices Enable Speedy Low-volume imagING (RIESLING) is a tool for reconstructing non-cartesian MRI scans. It was developed for reconstructing 3D radial center-out trajectories associated with Zero Echo-Time (ZTE) or Ultrashort Echo-Time (UTE) sequences. These trajectories provide unique challenges in efficient reconstruction compared to Cartesian trajectories (both 2D and 3D). However it is capable of reconstructing any trajectory.

.. toctree::
:maxdepth: 2
:caption: Contents:
:caption: Contents

contents
faq
data
recon
util
op

Indices and tables
==================
Commands
--------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
RIESLING is provided as a single executable file, similar to ``bart``. The ``riesling`` executable provides multiple individual commands, which vary from basic utilities to interrogate files to complete reconstruction pipelines. To see a full list of commands currently available, run ``riesling``. Detailed help for each command can be found in the category pages: :doc:`util`, :doc:`op`, and :doc:`recon`. The full list is not repeated here as they are subject to change. However, the most useful are:

- ``riesling h5`` Prints information about compatible ``.h5`` files
- ``riesling rss`` Performs the most basic reconstruction possible
- ``riesling admm`` Regularized least-squares reconstruction, similar to ``bart pics``. *You probably want this one*.

RIESLING exploits the inherent oversampling of most non-Cartesian trajectories at the center of k-space to generate SENSE maps directly from the input data, but utilities are provided to explicitly extract sensitivities if desired. Further details can be found in :doc:`util`. Internally, similarly to BART, RIESLING pipelines are constructed as a series of Linear Operators. These operators are exposed as individual commands if you wish to build up your own pipeline, see :doc:`op`.

Examples
--------

A `tutorial notebook <https://github.com/spinicist/riesling-examples/tutorial.ipynb>`_ can be run interactively at on `MyBinder <https://mybinder.org/v2/gh/spinicist/riesling-examples/HEAD?filepath=tutorial.ipynb>`_. This explains the various steps required to generate a simulated phantom dataset and then reconstruct it.

Input Data
----------

An important step with using RIESLING is providing data in the correct ``.h5`` format. Details of this format can be found in :doc:`data`. Matlab code to generate these files is provided in the ``/matlab`` directory of the repository. Users of the ZTE sequence on GE platforms should contact the authors to discuss conversion strategies.
25 changes: 0 additions & 25 deletions docs/intro.rst

This file was deleted.

0 comments on commit e5d7d79

Please sign in to comment.