Pluginise mpes reader

[domna]

The MPES reader is moving into its own plugin at https://github.com/FAIRmat-NFDI/pynxtools-mpes

Fixes #234

[coveralls]

Pull Request Test Coverage Report for Build 7977723693

Details

• 12 of 12 (100.0%) changed or added relevant lines in 2 files are covered.
• 41 unchanged lines in 8 files lost coverage.
• Overall coverage decreased (-1.0%) to 43.558%

---

Files with Coverage Reduction	New Missed Lines	%
pynxtools/dataconverter/readers/em_spctrscpy/utils/hspy/em_hspy_adf.py	2	11.38%
pynxtools/dataconverter/helpers.py	3	94.39%
pynxtools/dataconverter/readers/em_spctrscpy/utils/hspy/em_hspy_eels.py	3	9.38%
pynxtools/dataconverter/writer.py	3	89.08%
pynxtools/dataconverter/readers/em_spctrscpy/utils/hspy/em_hspy_xray.py	4	8.59%
pynxtools/nexus/nxdl_utils.py	8	73.7%
pynxtools/dataconverter/readers/utils.py	9	83.48%
pynxtools/nexus/nexus.py	9	71.46%

Totals
Change from base Build 7976686706:	-1.0%
Covered Lines:	4713
Relevant Lines:	10820

---

💛 - Coveralls

[domna]

@sherjeelshabih I removed all the mpes related tests and move this into the reader plugin. Do you think we need to recreate some tests for the example reader to cover functionality?

@rettigl This is mainly fyi. When everything is moved you need to do an additional pip install pynxtools-mpes and everything should be picked up automatically from there. I will also add this as an install extra as [mpes]

[lukaspie]

@rettigl This is mainly fyi. When everything is moved you need to do an additional pip install pynxtools-mpes and everything should be picked up automatically from there. I will also add this as an install extra as [mpes]

That's a good idea also for the other plugins. Maybe we could also make an install extra as [all-readers] or something that installs all plugins (at least the ones that we are aware of or for which we provide its own install extra)?

EDIT: I think in general it would be nice to also list the supported plugins in the pynxtools main repo somewhere (maybe also in README?)

[domna]

@rettigl This is mainly fyi. When everything is moved you need to do an additional pip install pynxtools-mpes and everything should be picked up automatically from there. I will also add this as an install extra as [mpes]

That's a good idea also for the other plugins. Maybe we could also make an install extra as [all-readers] or something that installs all plugins (at least the ones that we are aware of or for which we provide its own install extra)?

Yes, this is a good idea. We should have this for all plugins we support and I think it's also fine if people want to add their readers there.

EDIT: I think in general it would be nice to also list the supported plugins in the pynxtools main repo somewhere (maybe also in README?)

Yes, maybe we can get the list from the pynxtools-plugin topic. That way it would automatically update :) If not we can just keep a list but link to the topic.

[domna]

#247

[sherjeelshabih]

@sherjeelshabih I removed all the mpes related tests and move this into the reader plugin. Do you think we need to recreate some tests for the example reader to cover functionality?

I'll have a look on what tests etc will be needed separately. You can keep this PR for dealing with the MPES reader. I'll make an issue to check test coverage again for the JOSS paper.

[lukaspie]

LGTM, will do the same for https://github.com/FAIRmat-NFDI/pynxtools-xps.

[rettigl]

I tested it, and it works, however this changes the functionality of pynxtools, so we should discuss how to adjust versioning accordingly (we are probably the only ones using the mpes reader right now, but the next version of pynxtools without extras definition will break the behavior).

[domna]

I tested it, and it works, however this changes the functionality of pynxtools, so we should discuss how to adjust versioning accordingly (we are probably the only ones using the mpes reader right now, but the next version of pynxtools without extras definition will break the behavior).

Yes, we should follow proper semantic versioning for pynxtools to indicate when we introduce breaking changes. See #225. Ideally, we would now do the main changes until a v1.0.0 release so that we don't have to introduce breaking changes for a long time.

I would do a v0.1.0 release for the next version to indicate that we break something.