Skip to content

generalize python example note#1240

Merged
PeterC-DLS merged 10 commits into
mainfrom
1239-generalize-doc-note
Jun 11, 2026
Merged

generalize python example note#1240
PeterC-DLS merged 10 commits into
mainfrom
1239-generalize-doc-note

Conversation

@prjemian

Copy link
Copy Markdown
Contributor

@prjemian prjemian added this to the NXDL 2023.06 milestone Jan 25, 2023
@prjemian prjemian requested review from a team and rayosborn January 25, 2023 16:52
@prjemian prjemian self-assigned this Jan 25, 2023
@prjemian

Copy link
Copy Markdown
Contributor Author

Belated Happy Birthday wishes to this PR. Please review promptly.

@PeterC-DLS PeterC-DLS left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit more work needed

Comment thread manual/source/examples/python/simple_example_basic/index.rst Outdated
Comment thread manual/source/examples/python/simple_example_basic/index.rst Outdated
Comment thread manual/source/examples/python/simple_example_basic/index.rst Outdated
Comment thread manual/source/examples/python/simple_example_basic/index.rst Outdated
Comment thread manual/source/examples/python/simple_example_basic/index.rst
@prjemian

Copy link
Copy Markdown
Contributor Author

Thanks. @rayosborn : Can you assist with these changes?

@rayosborn

Copy link
Copy Markdown
Contributor

I'll take a look later today

@rayosborn

Copy link
Copy Markdown
Contributor

It's an improvement but it still needs a little work.

"The NeXus signal="I00" attribute on the :ref:NXdata group identifies I00 as the default y axis for the plot. The axes="mr" attribute on the :ref:NXdata group connects the dataset to be used as the x axis."

Perhaps a sentence should be added after this.

"In the nexusformat version, these attributes are added automatically when calling NXdata(y, x) with the first argument defining the signal and the second the axes. With signals of higher rank, the second argument would be a list of axes."

In the reader section, it says:

"The file reader, :ref:simple_example_basic_read.py <Example-Python-Reader>, opens the HDF5 we wrote above, prints the HDF5 attributes from the file, reads the two datasets, and then prints them out as columns. "

Actually, the nexusformat version prints the whole file as a tree.

@prjemian

Copy link
Copy Markdown
Contributor Author

initial table

image

Added nexusformat comments:

image

image

output is shown for each in tabs

image
image

@prjemian

Copy link
Copy Markdown
Contributor Author

@PeterC-DLS @rayosborn - Ready for review.

Comment thread manual/source/examples/python/simple_example_basic/index.rst Outdated
Comment thread manual/source/examples/python/simple_example_basic/index.rst Outdated
prjemian and others added 2 commits October 15, 2024 12:04
and then re-use `nxdata` later in the same line

Co-authored-by: Peter Chang <peter.chang@diamond.ac.uk>
@PeterC-DLS PeterC-DLS removed the request for review from rayosborn June 11, 2026 08:58
@PeterC-DLS PeterC-DLS closed this Jun 11, 2026
@PeterC-DLS PeterC-DLS reopened this Jun 11, 2026
@PeterC-DLS PeterC-DLS merged commit cf66993 into main Jun 11, 2026
2 checks passed
@PeterC-DLS PeterC-DLS deleted the 1239-generalize-doc-note branch June 11, 2026 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Generalize 'note' on the Python 'Getting started' page

4 participants