Skip to content

SRF inspection scripts and helper functions#6

Merged
lispandfound merged 40 commits intomainfrom
plots
Sep 11, 2024
Merged

SRF inspection scripts and helper functions#6
lispandfound merged 40 commits intomainfrom
plots

Conversation

@lispandfound
Copy link
Copy Markdown
Contributor

I wrote these to plot SRF data for the type-5 verification, but these could be very useful for anyone inspecting an SRF. Requires #4 to work correctly.

@lispandfound lispandfound marked this pull request as ready for review August 20, 2024 23:23
@AndrewRidden-Harper
Copy link
Copy Markdown
Contributor

these will be useful tools

@lispandfound
Copy link
Copy Markdown
Contributor Author

@joelridden wanted me to add script outputs, I've gone one better and added a wiki page with a reasonably detailed answer to the question "How do I plot x from an SRF?" We can hopefully point PhD students to this page in the future.

Copy link
Copy Markdown
Contributor

@joelridden joelridden left a comment

Choose a reason for hiding this comment

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

Just a few things, only mentioned the typer app() and title in 1 file but does apply to a few of the scripts. Love the documentation

Copy link
Copy Markdown
Contributor

@AndrewRidden-Harper AndrewRidden-Harper left a comment

Choose a reason for hiding this comment

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

Fantastic documentation!

Co-authored-by: Joel Ridden <33056240+joelridden@users.noreply.github.com>
joelridden
joelridden previously approved these changes Aug 25, 2024
claudio525
claudio525 previously approved these changes Aug 26, 2024
Copy link
Copy Markdown
Contributor

@claudio525 claudio525 left a comment

Choose a reason for hiding this comment

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

Looks great!

@lispandfound
Copy link
Copy Markdown
Contributor Author

Ok this pull is now finally in a good state again. The tests now run because the other PR got merged, and I fixed the coverage issues. There are a couple # pragma: no cover lines in a couple of scripts to tell the coverage tool to ignore the fact that the realisation related code is not tested. This isn't tested because workflow is not ready yet. Consider the behaviour of those branches beta and subject to change.

Parameters
----------
t : float
t : array-like
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.

Just to check, should this (and others) be array_like or is array-like ok?

Copy link
Copy Markdown
Contributor

@AndrewRidden-Harper AndrewRidden-Harper left a comment

Choose a reason for hiding this comment

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

It looks good. I just want to check that you intended to use array-like instead of array_like?

@lispandfound
Copy link
Copy Markdown
Contributor Author

@joelridden All good for you to review now.

@lispandfound lispandfound merged commit 3136f80 into main Sep 11, 2024
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.

4 participants