-
Notifications
You must be signed in to change notification settings - Fork 21
Rename doc files and fix typos #246
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,44 +10,50 @@ This example will demonstrate how to use the functions in the | |
|
||
1) Converting from ``q`` to ``2theta`` or ``d``: | ||
If you have a 1D ``q``-array, you can use the ``q_to_tth`` and ``q_to_d`` functions | ||
to convert it to ``2theta`` or ``d``. :: | ||
to convert it to ``2theta`` or ``d``. | ||
|
||
.. code-block:: python | ||
|
||
# Example: convert q to 2theta | ||
from diffpy.utils.transformers import q_to_tth | ||
from diffpy.utils.transforms import q_to_tth | ||
wavelength = 0.71 | ||
q = np.array([0, 0.2, 0.4, 0.6, 0.8, 1]) | ||
tth = q_to_tth(q, wavelength) | ||
|
||
# Example: convert q to d | ||
from diffpy.utils.transformers import q_to_d | ||
from diffpy.utils.transforms import q_to_d | ||
q = np.array([0, 0.2, 0.4, 0.6, 0.8, 1]) | ||
d = q_to_d(q) | ||
|
||
(2) Converting from ``2theta`` to ``q`` or ``d``: | ||
For a 1D ``2theta`` array, you can convert it to ``q`` or ``d`` in a similar way. :: | ||
For a 1D ``2theta`` array, you can convert it to ``q`` or ``d`` in a similar way. | ||
|
||
.. code-block:: python | ||
|
||
# Example: convert 2theta to q | ||
from diffpy.utils.transformers import tth_to_q | ||
from diffpy.utils.transforms import tth_to_q | ||
wavelength = 0.71 | ||
tth = np.array([0, 30, 60, 90, 120, 180]) | ||
q = tth_to_q(tth, wavelength) | ||
|
||
# Example: convert 2theta to d | ||
from diffpy.utils.transformers import tth_to_d | ||
from diffpy.utils.transforms import tth_to_d | ||
wavelength = 0.71 | ||
tth = np.array([0, 30, 60, 90, 120, 180]) | ||
d = tth_to_d(tth, wavelength) | ||
|
||
(3) Converting from ``d`` to ``q`` or ``2theta``: | ||
For a 1D ``d`` array, you can convert it to ``q`` or ``2theta``. :: | ||
For a 1D ``d`` array, you can convert it to ``q`` or ``2theta``. | ||
|
||
.. code-block:: python | ||
|
||
# Example: convert d to q | ||
from diffpy.utils.transformers import tth_to_q | ||
from diffpy.utils.transforms import d_to_q | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. good catch |
||
d = np.array([1.0, 0.8, 0.6, 0.4, 0.2]) | ||
q = d_to_q(d) | ||
|
||
# Example: convert d to 2theta | ||
from diffpy.utils.transformers import d_to_tth | ||
from diffpy.utils.transforms import d_to_tth | ||
wavelength = 0.71 | ||
d = np.array([1.0, 0.8, 0.6, 0.4, 0.2]) | ||
tth = d_to_tth(d, wavelength) |
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fix typo