HaeffnerLab / IonSim.jl

a simple tool for simulating trapped ion systems
https://ionsim.org
MIT License
70 stars 17 forks source link

New style #106

Closed neil-glikin closed 1 year ago

neil-glikin commented 1 year ago

Broadly gives IonSim a more "functional" programming feel.

Some major changes:

Some minor changes:

neil-glikin commented 1 year ago

Format check will fail; I think we should get rid of this for now, since it does a few undesirable things, for example spacing around math operators and spacing around the = in keyword arguments.

codecov[bot] commented 1 year ago

Codecov Report

Base: 91.5% // Head: 88.5% // Decreases project coverage by -3.0% :warning:

Coverage data is based on head (f6f9e1c) compared to base (9df6d9e). Patch coverage: 80.7% of modified lines in pull request are covered.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #106 +/- ## ======================================== - Coverage 91.5% 88.5% -3.0% ======================================== Files 15 15 Lines 1166 1240 +74 ======================================== + Hits 1067 1098 +31 - Misses 99 142 +43 ``` | [Impacted Files](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab) | Coverage Δ | | |---|---|---| | [src/IonSim.jl](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab#diff-c3JjL0lvblNpbS5qbA==) | `100.0% <ø> (ø)` | | | [src/timeevolution.jl](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab#diff-c3JjL3RpbWVldm9sdXRpb24uamw=) | `100.0% <ø> (ø)` | | | [src/iontraps.jl](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab#diff-c3JjL2lvbnRyYXBzLmps) | `87.9% <56.7%> (ø)` | | | [src/chambers.jl](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab#diff-c3JjL2NoYW1iZXJzLmps) | `71.3% <71.3%> (ø)` | | | [src/lasers.jl](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab#diff-c3JjL2xhc2Vycy5qbA==) | `81.0% <73.8%> (-16.9%)` | :arrow_down: | | [src/ions.jl](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab#diff-c3JjL2lvbnMuamw=) | `87.8% <84.5%> (+5.8%)` | :arrow_up: | | [src/vibrationalmodes.jl](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab#diff-c3JjL3ZpYnJhdGlvbmFsbW9kZXMuamw=) | `90.3% <90.3%> (ø)` | | | [src/analyticfunctions.jl](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab#diff-c3JjL2FuYWx5dGljZnVuY3Rpb25zLmps) | `100.0% <100.0%> (ø)` | | | [src/hamiltonians.jl](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab#diff-c3JjL2hhbWlsdG9uaWFucy5qbA==) | `93.3% <100.0%> (+2.3%)` | :arrow_up: | | [src/operators.jl](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab#diff-c3JjL29wZXJhdG9ycy5qbA==) | `98.6% <100.0%> (ø)` | | | ... and [8 more](https://codecov.io/gh/HaeffnerLab/IonSim.jl/pull/106?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab) | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HaeffnerLab)

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

jbroz11 commented 1 year ago

update docs