Create plasmapy.dispersion & migrate current functionality #910

qudsiramiz · 2020-10-05T18:53:46Z

Created a new folder dispersion in Top-Level Sub-Packages.

I have added a changelog entry for this pull request.

If adding new functionality, I have added tests and
docstrings.

I have fixed any newly failing tests.

renamed: plasmapy/formulary/dispersionfunction.py -> plasmapy/dispersion/dispersionfunction.py

modified: plasmapy/formulary/__init__.py

modified: plasmapy/formulary/dielectric.py

Updated the notebook to reflect the new location of dispersion.py file in the plasmapy

modified: docs/api_static/plasmapy.formulary.rst renamed: docs/formulary/dispersionfunction.rst -> docs/dispersion/dispersionfunction.rst new file: docs/dispersion/index.rst modified: docs/formulary/index.rst modified: plasmapy/dispersion/tests/test_dispersion.py

codecov · 2020-10-06T23:31:31Z

Codecov Report

Merging #910 into master will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #910   +/-   ##
=======================================
  Coverage   96.21%   96.21%           
=======================================
  Files          60       61    +1     
  Lines        5416     5416           
=======================================
  Hits         5211     5211           
  Misses        205      205

Impacted Files	Coverage Δ
plasmapy/dispersion/dispersionfunction.py	`100.00% <ø> (ø)`
plasmapy/formulary/__init__.py	`100.00% <ø> (ø)`
plasmapy/dispersion/__init__.py	`100.00% <100.00%> (ø)`
plasmapy/formulary/dielectric.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3ecf372...455a0e9. Read the comment docs.

This reverts commit 4449c46

…index.rst is the index for that subpackage

…onality and not repeat "irrelevant" formulary documentation

…apy.dispersion.dispersionfunction.rst; reformat to be consistent with other stub files

rocco8773

This is looking good! I've done a combination of review requested changes and push my own changes to your branch. I pushed changes related to dispersion documentation files .rst just because it would be too difficult to explain. Take a look at what I did and let me know if you have any questions.

changelog/910.breaking.rst

plasmapy/dispersion/__init__.py

docs/index.rst

Co-authored-by: Erik Everson <[email protected]>

qudsiramiz · 2020-10-12T18:57:42Z

This is looking good! I've done a combination of review requested changes and push my own changes to your branch. I pushed changes related to dispersion documentation files .rst just because it would be too difficult to explain. Take a look at what I did and let me know if you have any questions.

So...now that I have accepted the changes and committed them, can we go ahead and merge the two branches?

rocco8773 · 2020-10-12T19:12:54Z

@rocco8773 Ok, I'll review it and, if it looks good, I'll merge.

rocco8773

Looks good to me! Thanks for doing this!

rocco8773 · 2020-10-15T19:29:13Z

Closes #749

Ramiz Qudsi added 8 commits June 10, 2020 14:35

Update early_exit.sh

d4bbce0

Merge branch 'master' of https://github.com/ahmadryan/PlasmaPy

222caf3

Update early_exit.sh

4449c46

Merge branch 'master' of https://github.com/ahmadryan/PlasmaPy

e4a46d6

modified: .gitignore

e186f71

modified: .gitignore

deeace4

renamed: plasmapy/formulary/dispersionfunction.py -> plasmapy/dispersion/dispersionfunction.py

new file: plasmapy/dispersion/__init__.py

7500cb6

modified: plasmapy/formulary/__init__.py

modified: docs/about/credits.rst

6ac7bb7

rocco8773 requested review from rocco8773 and namurphy October 5, 2020 18:56

rocco8773 added the plasmapy.dispersion Related to the plasmapy.dispersion subpackage label Oct 5, 2020

Ramiz Qudsi added 10 commits October 6, 2020 11:37

moved the test_dispersion.py file to the relevant folder!

aa6c58a

deleted: upload.sh

e95d127

modified: plasmapy/dispersion/__init__.py

352f879

deleted: plasmapy/dispersion/dispersionsolver.py

b6a68c9

new file: changelog/910.breaking.rst

f2515da

formatted the dispersionfunction

5601059

deleted: .vscode/settings.json

58b93e4

modified: plasmapy/formulary/dielectric.py

Update dispersion_function.ipynb

a43541d

Updated the notebook

3298785

Updated the notebook to reflect the new location of dispersion.py file in the plasmapy

Ramiz Qudsi added 7 commits October 6, 2020 17:19

Editted __init__ file

72835b1

Edited the file to correct for the test documentation error

63feb8b

Edited the dispersionfunction.srt doc

a629a4b

Edited the dispersion index document

b2f6c5f

modified: docs/dispersion/dispersionfunction.rst

2846442

modified: index.rst

f31c5d7

init file edited

e06c1cb

Ramiz Qudsi added 3 commits October 6, 2020 18:26

init file changed

3e59a38

init file edited

a2fe95b

format change for consistency

b095d47

rocco8773 changed the title ~~Dispersion solver functionality~~ Create plasmapy.dispersion & migrate current functionality Oct 7, 2020

rocco8773 added 5 commits October 7, 2020 15:09

Revert "Update early_exit.sh"

ef3d52f

This reverts commit 4449c46

remove unused import

6669a3a

delete stub file api_static/plasmapy.dispersion.rst since dispersion/…

c6ac8b0

…index.rst is the index for that subpackage

update wording of dispersion/index.rst to reflect tht packages functi…

6b3c0a0

…onality and not repeat "irrelevant" formulary documentation

move stub file /dispersion/dispersionfunction.rst -> api_static/plasm…

c2706fd

…apy.dispersion.dispersionfunction.rst; reformat to be consistent with other stub files

rocco8773 requested changes Oct 7, 2020

View reviewed changes

Ramiz Qudsi and others added 5 commits October 12, 2020 14:35

Update changelog/910.breaking.rst

660ac5e

Co-authored-by: Erik Everson <[email protected]>

Update plasmapy/dispersion/__init__.py

2ab91e9

Co-authored-by: Erik Everson <[email protected]>

Update plasmapy/dispersion/__init__.py

5a4dbf4

Co-authored-by: Erik Everson <[email protected]>

Update plasmapy/dispersion/__init__.py

2f3b39d

Co-authored-by: Erik Everson <[email protected]>

Update docs/index.rst

bd49637

Co-authored-by: Erik Everson <[email protected]>

qudsiramiz requested a review from rocco8773 October 12, 2020 19:05

Merge branch 'master' into master

455a0e9

rocco8773 approved these changes Oct 15, 2020

View reviewed changes

rocco8773 merged commit be8fb77 into PlasmaPy:master Oct 15, 2020

StanczakDominik mentioned this pull request Aug 26, 2021

added property based tests using hypothesis #1249

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create plasmapy.dispersion & migrate current functionality #910

Create plasmapy.dispersion & migrate current functionality #910

qudsiramiz commented Oct 5, 2020 •

edited

Loading

codecov bot commented Oct 6, 2020 •

edited

Loading

rocco8773 left a comment

qudsiramiz commented Oct 12, 2020

rocco8773 commented Oct 12, 2020

rocco8773 left a comment

rocco8773 commented Oct 15, 2020

Create plasmapy.dispersion & migrate current functionality #910

Create plasmapy.dispersion & migrate current functionality #910

Conversation

qudsiramiz commented Oct 5, 2020 • edited Loading

codecov bot commented Oct 6, 2020 • edited Loading

Codecov Report

rocco8773 left a comment

Choose a reason for hiding this comment

qudsiramiz commented Oct 12, 2020

rocco8773 commented Oct 12, 2020

rocco8773 left a comment

Choose a reason for hiding this comment

rocco8773 commented Oct 15, 2020

qudsiramiz commented Oct 5, 2020 •

edited

Loading

codecov bot commented Oct 6, 2020 •

edited

Loading