search

stfc / HartreeParticleDSL

MIT License
1 stars 1 forks source link

Started expanding docs #73

Open LonelyCat124 opened 1 year ago

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (7d5d2a9) 100.00% compared to head (2eb1aad) 100.00%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #73 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 72 72 Lines 7606 7606 ========================================= Hits 7606 7606 ``` | [Impacted Files](https://app.codecov.io/gh/stfc/HartreeParticleDSL/pull/73?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=stfc) | Coverage Δ | | |---|---|---| | [...rtreeParticleDSL/Particle\_IR/nodes/array\_member.py](https://app.codecov.io/gh/stfc/HartreeParticleDSL/pull/73?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=stfc#diff-c3JjL0hhcnRyZWVQYXJ0aWNsZURTTC9QYXJ0aWNsZV9JUi9ub2Rlcy9hcnJheV9tZW1iZXIucHk=) | `100.00% <ø> (ø)` | | | [...backends/AST\_to\_Particle\_IR/ast\_to\_pir\_visitors.py](https://app.codecov.io/gh/stfc/HartreeParticleDSL/pull/73?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=stfc#diff-c3JjL0hhcnRyZWVQYXJ0aWNsZURTTC9iYWNrZW5kcy9BU1RfdG9fUGFydGljbGVfSVIvYXN0X3RvX3Bpcl92aXNpdG9ycy5weQ==) | `100.00% <ø> (ø)` | | | [...ticleDSL/backends/Cabana\_PIR\_backend/cabana\_pir.py](https://app.codecov.io/gh/stfc/HartreeParticleDSL/pull/73?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=stfc#diff-c3JjL0hhcnRyZWVQYXJ0aWNsZURTTC9iYWNrZW5kcy9DYWJhbmFfUElSX2JhY2tlbmQvY2FiYW5hX3Bpci5weQ==) | `100.00% <ø> (ø)` | | | [...rtreeParticleDSL/Particle\_IR/datatypes/datatype.py](https://app.codecov.io/gh/stfc/HartreeParticleDSL/pull/73?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=stfc#diff-c3JjL0hhcnRyZWVQYXJ0aWNsZURTTC9QYXJ0aWNsZV9JUi9kYXRhdHlwZXMvZGF0YXR5cGUucHk=) | `100.00% <100.00%> (ø)` | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

LonelyCat124 commented 1 year ago

In terms of old examples, the 02_HDF5_examples directory is fully out of date so we'll remove it, as the basic IO example already covers it. The 03_PIC_examples need documenting and cleaning up to remove the non-PIR implementation. The 04_sourcesink_boundaries probably needs some examples of implementing source and sink boundary conditions and documentaiton. The 05_electron_scattering will just stay undocumented/incomplete for now.