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

Updating smileih5.py #274

Merged
merged 10 commits into from
Jan 29, 2024
Merged

Updating smileih5.py #274

merged 10 commits into from
Jan 29, 2024

Conversation

VinithSamson11
Copy link
Contributor

No description provided.

@skuschel skuschel added reader specific change is affecting a specific reader class enhancement labels Jan 21, 2024
The doc-stings were added and the code is tested using run-tests.py
@VinithSamson11
Copy link
Contributor Author

Code integrity is tested using run-tests.py (passed all tests)
Detailed Doc-stings were added for main functions.
And code's performance and working were tested using jupyter notebook.

@skuschel
Copy link
Owner

skuschel commented Jan 23, 2024

Great thanks! I have a few minor remarks:

  • Please add your name to the to top of the file in the comment
  • Please reorder the functions, so its easier to keep track what depneds on what. The order should be as in https://github.com/skuschel/postpic/blob/master/postpic/datareader/openPMDh5.py
    1. __init__ funciton
    2. any static methods (the ones decorated with @staticmethod)
    3. # --- Level 0 methods ---
    4. # --- Level 1 methods ---
    5. # --- Level 2 methods ---. Please leave those comments in, even if there are not functions in this group. For example there are no Level 0 functions being overriden, but there are level 1 functions currently at the end of the file.
  • rename getAMmodes to _listAMmodes.
  • rename getExpanded to _getExpanded
  • Please comment here which smilei and which happi version you are using

@skuschel
Copy link
Owner

Oh and please update the Changelog.md file under current master that a reader for smilei version whatever has been added including a link to the smilei repo

@VinithSamson11
Copy link
Contributor Author

The Changes you mentioned have been made. The version I have used is smilei v4.8.

@VinithSamson11
Copy link
Contributor Author

The smileih5.py file were tested with latest SmileiPIC (v5.0) & Happi version. The test data were dumped from Smilei version v5.0 and the the output values are compared with latest corresponding version of Happi. The percentage errors are in the order of ~10^-13 %.

@skuschel skuschel merged commit 02b11e6 into skuschel:dev Jan 29, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement reader specific change is affecting a specific reader class
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants