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

DOC: Add spherical harmonics basis documentation. #1657

Merged
merged 1 commit into from Nov 7, 2018

Conversation

Projects
None yet
5 participants
@jhlegarreta
Copy link
Contributor

jhlegarreta commented Oct 27, 2018

Add spherical harmonics function basis documentation.

@jhlegarreta

This comment has been minimized.

Copy link
Contributor

jhlegarreta commented Oct 27, 2018

According to what was discussed in #1653.

I added the document to the index so that it is displayed in dipy.org.

Feel free to improve it.

Somehow related:

  • Note that only another file in the group is listed.
  • Does the title in b_and_q.rst miss a P (i.e. DIPY), or else was that done in purpose? @matthew-brett
@codecov-io

This comment has been minimized.

Copy link

codecov-io commented Oct 27, 2018

Codecov Report

❗️ No coverage uploaded for pull request base (master@01a2994). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #1657   +/-   ##
=========================================
  Coverage          ?   87.59%           
=========================================
  Files             ?      248           
  Lines             ?    34134           
  Branches          ?     3746           
=========================================
  Hits              ?    29899           
  Misses            ?     3343           
  Partials          ?      892

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 01a2994...abd77c6. Read the comment docs.

@jhlegarreta jhlegarreta force-pushed the jhlegarreta:AddSHBasisTheoryDoc branch from 2bdcb5e to fe939f5 Oct 27, 2018

@skoudoro
Copy link
Member

skoudoro left a comment

LGTM. Can you have a look @jchoude @Garyfallidis @arokem?

@arokem
Copy link
Member

arokem left a comment

Overall, looks good. Just a couple of comments from me.

Show resolved Hide resolved doc/theory/sh_basis.rst Outdated
Show resolved Hide resolved doc/theory/sh_basis.rst Outdated
Show resolved Hide resolved doc/theory/sh_basis.rst Outdated
Show resolved Hide resolved doc/theory/sh_basis.rst Outdated

@jhlegarreta jhlegarreta force-pushed the jhlegarreta:AddSHBasisTheoryDoc branch 2 times, most recently from a7e9271 to 2ea22b5 Oct 30, 2018

Show resolved Hide resolved doc/theory/sh_basis.rst Outdated
Show resolved Hide resolved doc/theory/sh_basis.rst Outdated
Show resolved Hide resolved doc/theory/sh_basis.rst

@jhlegarreta jhlegarreta force-pushed the jhlegarreta:AddSHBasisTheoryDoc branch from 2ea22b5 to 43fa829 Oct 30, 2018

DOC: Add spherical harmonics basis documentation.
Add spherical harmonics function basis documentation.

@jhlegarreta jhlegarreta force-pushed the jhlegarreta:AddSHBasisTheoryDoc branch from 43fa829 to abd77c6 Oct 31, 2018

@jhlegarreta

This comment has been minimized.

Copy link
Contributor

jhlegarreta commented Oct 31, 2018

abd77c6 adds a cross-reference to the module so that the theory links to the actual source code where the sh bases dwell in DIPY.

@jhlegarreta

This comment has been minimized.

Copy link
Contributor

jhlegarreta commented Nov 6, 2018

@arokem @skoudoro if the filename and title are OK, then we can resolve the conversation and this would be ready to be merged.

@skoudoro

This comment has been minimized.

Copy link
Member

skoudoro commented Nov 6, 2018

It is ok for me so if there is no answer until tomorrow, I will go ahead and merge it

@skoudoro skoudoro merged commit a600967 into nipy:master Nov 7, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@skoudoro

This comment has been minimized.

Copy link
Member

skoudoro commented Nov 7, 2018

Thanks @jhlegarreta!

@jhlegarreta jhlegarreta deleted the jhlegarreta:AddSHBasisTheoryDoc branch Nov 7, 2018

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