Thomson Scattering Module Initial Commit #831

pheuer · 2020-06-03T22:32:26Z

This PR adds a file plasmapy/diagnostics/thomson.py which contain a code for simulating Thomson scattering spectra for Maxwellian plasmas in both the collective and non-collective regimes.

An associated file of tests is also added: plasmapy/diagnostics/tests/test_thomson.py. This file contains two tests that run the program in two regimes (collective and non-collective) and make sure the results match their current output values.

pep8speaks · 2020-06-03T22:32:29Z

Hello @pheuer! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

In the file plasmapy/diagnostics/thomson.py:

Line 141:91: E501 line too long (128 > 90 characters)

Comment last updated at 2020-06-10 18:28:38 UTC

codecov · 2020-06-03T22:36:02Z

Codecov Report

Merging #831 into master will increase coverage by 0.05%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #831      +/-   ##
==========================================
+ Coverage   95.94%   95.99%   +0.05%     
==========================================
  Files          56       58       +2     
  Lines        5126     5195      +69     
==========================================
+ Hits         4918     4987      +69     
  Misses        208      208

Impacted Files	Coverage Δ
plasmapy/diagnostics/__init__.py	`100.00% <100.00%> (ø)`
plasmapy/diagnostics/thomson.py	`100.00% <100.00%> (ø)`
plasmapy/formulary/parameters.py	`98.89% <0.00%> (+0.01%)`	⬆️

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 d8e358f...74ca375. Read the comment docs.

This reverts commit 2df8dd5.

rocco8773 · 2020-06-04T01:01:24Z

Hi @pheuer, thanks again for doing this. Like I said in our emails, I'll try to give a proper review by the end of the week. To get started, look into...

Replacing the use of quantity_input with validate_quantities.
The documentation page for diagnostics will need to be updated.
It might be useful to create a jupyter notebook to show how the package works. This would go in ./docs/notebooks and we could add it to the nbgallery you see on the documentation page.

StanczakDominik · 2020-06-04T07:31:04Z

I'd definitely like to also take a look at this functionality :)

StanczakDominik

Thanks for doing this, @pheuer! Looks great. Here's my initial look-through with a bunch of suggestions.

I fully agree with @rocco8773 that an example notebook analysis could be very helpful for showcasing what this can do :)

changelog/831.feature.rst

plasmapy/diagnostics/thomson.py

Co-authored-by: Dominik Stańczak <[email protected]>

No idea if I've done this correctly, or if there's more I need to do in the docstrings in the actual functions to have this process correctly?

pheuer · 2020-06-04T19:40:33Z

Thanks for the comments! In addition to the changes noted above, I have also created an example Jupyter notebook and attempted to edit the diagnostics page in the documentation (although I'm not sure if there's more I need to do in the actual function docstrings to make that work properly?).

rocco8773

This looks really good. Thank you for doing this! There are just a few spelling/format fixes and then this will be the final review.

docs/diagnostics/thomson.rst

plasmapy/diagnostics/thomson.py

docs/notebooks/thomson.ipynb

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

pheuer · 2020-06-22T23:01:04Z

@rocco8773 Great, thank you for catching the spelling/formatting errors!

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

somehow we missed formatting the weakly_collective dictionary

reformat caption list so it looks nice on RTD and in a notebook cell

StanczakDominik · 2020-06-23T08:03:18Z

Woo! Thanks @pheuer for this PR, and thanks @rocco8773 for carrying the review :D

namurphy · 2020-06-23T15:53:41Z

Yes, thank you! This is really exciting!

pheuer · 2020-06-23T16:13:56Z

Thank you all for your help! Looking forward to adding more in the future.

pheuer added 6 commits June 2, 2020 18:14

thompson.py initial commit

e49009d

Update thomson.py

6228a19

Initial commit test_thomson.py

50ebba6

Formatting edits to thomson.py

c5020b6

Documentation improvements, output mean(alpha)

13a9d85

Merge remote-tracking branch 'upstream/master'

92c38c7

rocco8773 self-requested a review June 3, 2020 22:34

rocco8773 assigned rocco8773 and pheuer Jun 3, 2020

rocco8773 added plasmapy.diagnostics Related to the plasmapy.diagnostics subpackage needs changelog entry See: https://docs.plasmapy.org/en/latest/contributing/changelog_guide.html labels Jun 3, 2020

pheuer added 4 commits June 3, 2020 16:22

Formatting changes to Thomson code for PEP8 compliance

ab1d5b4

Added Changelog entry for Thomson scattering function

2df8dd5

Revert "Added Changelog entry for Thomson scattering function"

667da57

This reverts commit 2df8dd5.

Create 831.feature.rst

caa4dc9

StanczakDominik self-requested a review June 4, 2020 07:30

StanczakDominik reviewed Jun 4, 2020

View reviewed changes

pheuer and others added 7 commits June 4, 2020 10:35

Update changelog/831.feature.rst

9fbed53

Co-authored-by: Dominik Stańczak <[email protected]>

Update plasmapy/diagnostics/thomson.py

7f8a3e1

Co-authored-by: Dominik Stańczak <[email protected]>

Update thomson.py

a0c22ee

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

574e042

Initial commit for example notebook thomson.ipynb

42c8f88

Update thomson.py

56598bf

Revised Diagnostics documentation to include Thomson module

62e2636

No idea if I've done this correctly, or if there's more I need to do in the docstrings in the actual functions to have this process correctly?

StanczakDominik self-requested a review June 5, 2020 03:33

pheuer marked this pull request as ready for review June 22, 2020 17:56

rocco8773 requested changes Jun 22, 2020

View reviewed changes

pheuer and others added 16 commits June 22, 2020 15:57

Update docs/diagnostics/thomson.rst

4d53841

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

Update plasmapy/diagnostics/thomson.py

3ccb92a

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

Update plasmapy/diagnostics/thomson.py

37a35e5

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

Update plasmapy/diagnostics/thomson.py

852dde7

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

Update plasmapy/diagnostics/thomson.py

35f02ae

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

Update docs/notebooks/thomson.ipynb

9f05d8d

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

Update plasmapy/diagnostics/thomson.py

2bc229b

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

Update docs/notebooks/thomson.ipynb

150ece3

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

Update docs/notebooks/thomson.ipynb

5301b3b

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

Update docs/notebooks/thomson.ipynb

5821143

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

Update plasmapy/diagnostics/thomson.py

6c1fdad

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

Update plasmapy/diagnostics/thomson.py

dc9c9b4

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

Update plasmapy/diagnostics/tests/test_thomson.py

5bb345e

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

Update plasmapy/diagnostics/tests/test_thomson.py

f7b48ea

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

Update docs/notebooks/thomson.ipynb

a8c0b4c

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

Update docs/notebooks/thomson.ipynb

e77d8f1

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

pheuer and others added 4 commits June 22, 2020 16:35

Update plasmapy/diagnostics/thomson.py

e5da25a

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

PEP8: dictionary whitespace

db6ffb9

format the weakly_collective dictionary

fca9a64

somehow we missed formatting the weakly_collective dictionary

reformat caption list

74ca375

reformat caption list so it looks nice on RTD and in a notebook cell

rocco8773 approved these changes Jun 23, 2020

View reviewed changes

rocco8773 merged commit 5080c25 into PlasmaPy:master Jun 23, 2020

rocco8773 mentioned this pull request Jun 23, 2020

Add Thomson Scatering Spectral Density to Feature Card PlasmaPy/plasmapy.github.io#62

Merged

namurphy mentioned this pull request Jan 19, 2021

Drop Python 3.6 support for version 0.6.0 #980

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Thomson Scattering Module Initial Commit #831

Thomson Scattering Module Initial Commit #831

pheuer commented Jun 3, 2020

pep8speaks commented Jun 3, 2020 •

edited

Loading

codecov bot commented Jun 3, 2020 •

edited

Loading

rocco8773 commented Jun 4, 2020

StanczakDominik commented Jun 4, 2020

StanczakDominik left a comment

pheuer commented Jun 4, 2020

rocco8773 left a comment

pheuer commented Jun 22, 2020

StanczakDominik commented Jun 23, 2020

namurphy commented Jun 23, 2020

pheuer commented Jun 23, 2020

Thomson Scattering Module Initial Commit #831

Thomson Scattering Module Initial Commit #831

Conversation

pheuer commented Jun 3, 2020

pep8speaks commented Jun 3, 2020 • edited Loading

Comment last updated at 2020-06-10 18:28:38 UTC

codecov bot commented Jun 3, 2020 • edited Loading

Codecov Report

rocco8773 commented Jun 4, 2020

StanczakDominik commented Jun 4, 2020

StanczakDominik left a comment

Choose a reason for hiding this comment

pheuer commented Jun 4, 2020

rocco8773 left a comment

Choose a reason for hiding this comment

pheuer commented Jun 22, 2020

StanczakDominik commented Jun 23, 2020

namurphy commented Jun 23, 2020

pheuer commented Jun 23, 2020

pep8speaks commented Jun 3, 2020 •

edited

Loading

codecov bot commented Jun 3, 2020 •

edited

Loading