legend-exp / pygama

Python package for data processing and analysis
https://pygama.readthedocs.io
GNU General Public License v3.0
18 stars 56 forks source link

Remove `pygama.{lgdo,raw,dsp}` subpackages #500

Closed gipert closed 1 year ago

gipert commented 1 year ago

The source code has moved to

Corresponding tests and documentation have been removed as well.

importing pygama.{lgdo,raw,dsp} still works (I added wildcard imports from the new packages), but will emit a deprecation warning. The subpackages will be completely removed in the future.

This should not impact existing user programs, which should be however updated to import code from the new packages:

import pygama.lgdo -> import lgdo
import pygama.raw -> import daq2lh5
import pygama.dsp -> import dspeed

DSP configuration dictionaries should be updated to import processors from dspeed (and not pygama.dsp).

Also: closes #482.

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 46.87% and project coverage change: -27.57 :warning:

Comparison is base (30b90a5) 48.66% compared to head (7def658) 21.09%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #500 +/- ## =========================================== - Coverage 48.66% 21.09% -27.57% =========================================== Files 104 30 -74 Lines 12525 5759 -6766 =========================================== - Hits 6095 1215 -4880 + Misses 6430 4544 -1886 ``` | [Impacted Files](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp) | Coverage Δ | | |---|---|---| | [src/pygama/cli.py](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp#diff-c3JjL3B5Z2FtYS9jbGkucHk=) | `0.00% <0.00%> (-68.11%)` | :arrow_down: | | [src/pygama/evt/\_\_init\_\_.py](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp#diff-c3JjL3B5Z2FtYS9ldnQvX19pbml0X18ucHk=) | `0.00% <0.00%> (ø)` | | | [src/pygama/evt/build\_tcm.py](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp#diff-c3JjL3B5Z2FtYS9ldnQvYnVpbGRfdGNtLnB5) | `0.00% <0.00%> (ø)` | | | [src/pygama/lgdo/\_\_init\_\_.py](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp#diff-c3JjL3B5Z2FtYS9sZ2RvL19faW5pdF9fLnB5) | `0.00% <0.00%> (-100.00%)` | :arrow_down: | | [src/pygama/pargen/AoE\_cal.py](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp#diff-c3JjL3B5Z2FtYS9wYXJnZW4vQW9FX2NhbC5weQ==) | `0.00% <0.00%> (ø)` | | | [src/pygama/pargen/ecal\_th.py](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp#diff-c3JjL3B5Z2FtYS9wYXJnZW4vZWNhbF90aC5weQ==) | `0.00% <0.00%> (ø)` | | | [src/pygama/pargen/extract\_tau.py](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp#diff-c3JjL3B5Z2FtYS9wYXJnZW4vZXh0cmFjdF90YXUucHk=) | `0.00% <0.00%> (ø)` | | | [src/pygama/raw/\_\_init\_\_.py](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp#diff-c3JjL3B5Z2FtYS9yYXcvX19pbml0X18ucHk=) | `0.00% <0.00%> (-100.00%)` | :arrow_down: | | [src/pygama/vis/\_\_init\_\_.py](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp#diff-c3JjL3B5Z2FtYS92aXMvX19pbml0X18ucHk=) | `0.00% <ø> (-100.00%)` | :arrow_down: | | [src/pygama/dsp/\_\_init\_\_.py](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp#diff-c3JjL3B5Z2FtYS9kc3AvX19pbml0X18ucHk=) | `100.00% <100.00%> (ø)` | | | ... and [8 more](https://app.codecov.io/gh/legend-exp/pygama/pull/500?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp) | | ... and [3 files with indirect coverage changes](https://app.codecov.io/gh/legend-exp/pygama/pull/500/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=legend-exp)

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

gipert commented 1 year ago

@jasondet @iguinn can you give this a look?

gipert commented 1 year ago

@jasondet ready to merge from my side.

jasondet commented 1 year ago

ok let's do it!