Skip to content
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.

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

Documentation structure changes #159

Open
6 tasks
sfarrens opened this issue Jul 20, 2022 · 0 comments
Open
6 tasks

Documentation structure changes #159

sfarrens opened this issue Jul 20, 2022 · 0 comments

Comments

@sfarrens
Copy link
Contributor

To better match the standards introduced in PySAP issue #179 I propose that the following changes be made to PySAP-MRI.

in examples

  • Update the README.txt as follows:
    .. _mri_examples:
    
    MRI Examples
    ------------
    
    Here we present a selection of examples using tools provided in the PySAP-MRI plug-in.
    
  • Prefix all example file names with plot_, so that a thumbnail can be displayed.
  • For any images to be rendered (including the thumbnail) use Matplotlib instead of the PySAP built-in show method. Note that the thumbnail will be the first image rendered.
  • Use # %% to define new notebook cells.

in mri

  • Update __init__.py as follows.
    """PYSAP-MRI.
    
    This plug-in provides tools for magnetic resonance imaging data processing.
    
    """
  • Ensure that all parameters/returns data types are valid (where possible). (e.g. np.array -> numpy.ndarray)

Refer to PySAP-ASTRO for examples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant