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

Normalization Tab Algorithm #28

Merged
merged 7 commits into from
May 8, 2024
Merged

Normalization Tab Algorithm #28

merged 7 commits into from
May 8, 2024

Conversation

mpatrou
Copy link
Collaborator

@mpatrou mpatrou commented May 7, 2024

Description of Changes:

The diagram of the normalization algorithm.
marked in progress

Related Items

To Test:

Documentation - Diagram of the Normalization algorithm

cd /path/to/my/local/garnet/repo/
git fetch origin pull/<PULL_REQUEST_NUMBER>/head:pr<PULL_REQUEST_NUMBER>
git switch pr<PULL_REQUEST_NUMBER>
conda activate <garnet_environment>
python -m pytest <item_to_test>

Check list for the pull request

  • I have read the [CONTRIBUTING]
  • I have read the [CODE_OF_CONDUCT]
  • I have added tests for my changes
  • I have updated the documentation accordingly

Check list for the reviewer

  • I have read the [CONTRIBUTING]
  • I have verified the proposed changes
  • best software practices
    • all internal functions have an underbar, as is python standard
    • clearly named variables (better to be verbose in variable names)
    • code comments explaining the intent of code blocks
  • All the tests are passing
  • The documentation is up to date
  • code comments added when explaining intent

Copy link

codecov bot commented May 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5245244) to head (6e305a7).

Additional details and impacted files
@@            Coverage Diff            @@
##              next       #28   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           13        13           
  Lines          236       236           
=========================================
  Hits           236       236           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@searscr searscr left a comment

Choose a reason for hiding this comment

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

Can't speak to the accuracy of the normalization flow for each instrument but it looks good to the best of my understanding. Documentation builds correctly and looks good.

Copy link

@hetrickjm hetrickjm left a comment

Choose a reason for hiding this comment

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

All looks good and consistent. Note that I did not try to build the doc site locally as I am not setup todo so. Otherwise it looks good.

@mpatrou mpatrou merged commit 8adfd88 into next May 8, 2024
6 checks passed
@mpatrou mpatrou deleted the normalization_tab_dsn branch May 8, 2024 12:28
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.

3 participants