Olender / spyro-1

Acoustic wave propagators for seismic domains with application to full waveform inversion.
GNU General Public License v3.0
3 stars 0 forks source link

DOcumentation #32

Closed Olender closed 1 year ago

Olender commented 1 year ago

adding docs

codecov-commenter commented 1 year ago

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (aefce91) 85.87% compared to head (1f41b3e) 85.89%. Report is 1 commits behind head on main.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #32 +/- ## ========================================== + Coverage 85.87% 85.89% +0.01% ========================================== Files 44 44 Lines 2577 2587 +10 ========================================== + Hits 2213 2222 +9 - Misses 364 365 +1 ``` | [Files](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender) | Coverage Δ | | |---|---|---| | [spyro/examples/cut\_marmousi.py](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender#diff-c3B5cm8vZXhhbXBsZXMvY3V0X21hcm1vdXNpLnB5) | `93.33% <ø> (ø)` | | | [spyro/examples/marmousi.py](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender#diff-c3B5cm8vZXhhbXBsZXMvbWFybW91c2kucHk=) | `93.33% <ø> (ø)` | | | [spyro/examples/rectangle.py](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender#diff-c3B5cm8vZXhhbXBsZXMvcmVjdGFuZ2xlLnB5) | `93.93% <ø> (ø)` | | | [spyro/io/backwards\_compatibility\_io.py](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender#diff-c3B5cm8vaW8vYmFja3dhcmRzX2NvbXBhdGliaWxpdHlfaW8ucHk=) | `96.42% <ø> (ø)` | | | [spyro/io/basicio.py](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender#diff-c3B5cm8vaW8vYmFzaWNpby5weQ==) | `83.03% <ø> (ø)` | | | [spyro/io/boundary\_layer\_io.py](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender#diff-c3B5cm8vaW8vYm91bmRhcnlfbGF5ZXJfaW8ucHk=) | `90.00% <ø> (ø)` | | | [spyro/io/model\_parameters.py](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender#diff-c3B5cm8vaW8vbW9kZWxfcGFyYW1ldGVycy5weQ==) | `82.84% <100.00%> (ø)` | | | [spyro/meshing/meshing\_functions.py](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender#diff-c3B5cm8vbWVzaGluZy9tZXNoaW5nX2Z1bmN0aW9ucy5weQ==) | `85.31% <ø> (ø)` | | | [spyro/receivers/Receivers.py](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender#diff-c3B5cm8vcmVjZWl2ZXJzL1JlY2VpdmVycy5weQ==) | `37.20% <ø> (ø)` | | | [spyro/receivers/changing\_coordinates.py](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender#diff-c3B5cm8vcmVjZWl2ZXJzL2NoYW5naW5nX2Nvb3JkaW5hdGVzLnB5) | `99.05% <ø> (ø)` | | | ... and [4 more](https://app.codecov.io/gh/Olender/spyro-1/pull/32?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandre+Olender) | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.