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.

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

Jump to bottom

[ONGOING] Documentation of the Project #43

Open
11 of 18 tasks
schote opened this issue Dec 14, 2023 · 0 comments · Fixed by #45 or #47
Open
11 of 18 tasks

[ONGOING] Documentation of the Project #43

schote opened this issue Dec 14, 2023 · 0 comments · Fixed by #45 or #47
Assignees
@schote
Labels
priority: medium type: documentation Improvements or additions to documentation
Milestone
Documentation

Comments

@schote
Copy link
Owner

schote commented Dec 14, 2023 •
edited
Loading

This is an ongoing task.

The documentation, which is deployed to GitHub pages contains the following sections:

  • Quick start guide: How to install
  • User guide: Explain concepts
  • Examples
  • API reference: Code documentation

The user guide should explain the following concepts:

  • Acquisition control
  • Interfaces
  • Sequence calculation
  • Spectrum device
  • Transmit device
  • Receive device
  • Sequence constructors
  • DDC
  • SNR

Examples to be implemented:

  • Execute a simple sequence (spectrum)
  • Image acquisition
  • Plot a sequence
  • SNR calculation
  • Compare DDC functions
@schote schote changed the title Documentation of the Spectrum-Console Project Documentation of the Project Dec 14, 2023
@schote schote self-assigned this Dec 14, 2023
@schote schote added type: documentation Improvements or additions to documentation priority: medium labels Dec 14, 2023
@schote schote linked a pull request Dec 14, 2023 that will close this issue
Project documentation with GitHub pages #45
Merged
@schote schote reopened this Jan 5, 2024
@schote schote linked a pull request Jan 5, 2024 that will close this issue
Documentation, fixes and improvements #47
Merged
7 tasks
@schote schote closed this as completed in #47 Jan 5, 2024
@schote schote reopened this Jan 5, 2024
@schote schote added this to the Documentation milestone Jan 25, 2024
@schote schote changed the title Documentation of the Project [ONGOING] Documentation of the Project May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@schote schote

Labels
priority: medium type: documentation Improvements or additions to documentation
Projects
Low-Field MRI Console
Status: Done
Milestone
Documentation
1 participant
@schote