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: updates and fixes/review #288

Merged
merged 8 commits into from
Oct 14, 2024
Merged

Conversation

FedeMPouzols
Copy link
Collaborator

  • The methods of ProcessingSet and MeasurementSetXds are now rendered
  • ps_vis tutorial is updated to recent changes in nomenclature, the other (guides) notebooks are also updated
  • various links are fixed to avoid absolute and/or local file links

About measurement_set_overview, I only made small or technical fixes. The few points about content that came to mind:

  • In " data for a single observation, spectral window, polarization setup, observation mode, processor and beam per antenna" - should this also mention field (perhaps saying "typically" or similar)? Even though there is an exception, OTF, that is the default and by far the most common case I would expect.
  • In Figure 1: "state_info" - is this new or being requested? Also, a bit further below in the table of MSv2=>MSv4 translation, state_info is listed as 'dataset' but it seems it would be a dict.
  • Figure 2: this is now duplicated in the 'development' notebook (which perhaps could refer to this one).
  • Perhaps, but not needed at this level of detail, where we say "table concept of rows has been replaced by relevant dimensions" => dimensions have replaced the concept of rows and also the dimensions of the "Format" column of the MSv2 tables, or dimensions of the corresponding casacore arrays for non-scalar data.

For the API fixes, I used the :members: directive. It seems we could also auto-generate everything as-is in the code using the extension 'sphinx.ext.autosummary'. Maybe we want to use that in the near future once the API is stable.
Note that I changed the top heading of measurement_set_api.rst to "Processing Set and Measurement Set API" as this made better sense to me considering what is included there, but please double-check.


Note well:

This contribution is made under the current ALMA software agreements. 
(c) European Southern Observatory, 2024 
Copyright by ESO (in the framework of the ALMA collaboration)

@Jan-Willem Jan-Willem merged commit 3ce3331 into main Oct 14, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants