Skip to content

NEW Restructure python data IO/actions#1098

Merged
Zaharid merged 5 commits into
masterfrom
restruct-pydat-alt
Feb 24, 2021
Merged

NEW Restructure python data IO/actions#1098
Zaharid merged 5 commits into
masterfrom
restruct-pydat-alt

Conversation

@wilsonmr
Copy link
Copy Markdown
Contributor

supercedes #1080 but I left that open just in case.

here I implemented: #1080 (comment)

in addition to that I decided to just make the functions which built covmats into actions which meant we could get rid of unneccessary rubbish, in a similar manner to @siranipour's idea with #866 (simply changing the signature). I may have broken something along the way.

I think this is a good balance between not having unneccessary subdir but also it's slightly clearer where things should be

@RosalynLP
Copy link
Copy Markdown
Contributor

Sorry for not reviewing yet! I will get round to it soon I promise

@Zaharid
Copy link
Copy Markdown
Contributor

Zaharid commented Feb 22, 2021

FWIW I am fine with this split.

Copy link
Copy Markdown
Contributor

@RosalynLP RosalynLP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this layout - it's a simpler restructuring but groups things well, and also the new docs are very helpful.

Comment thread doc/sphinx/source/vp/pydataobjs.rst Outdated
from validphys.api import API
from validphys.commondataparser import load_commondata
inp = {
"dataset_input": {"dataset":"NMC"},
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we try an example with cfacs here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure!

Comment thread validphys2/src/validphys/commondata.py Outdated
Comment thread validphys2/src/validphys/covmats.py
@siranipour
Copy link
Copy Markdown
Contributor

Is it worth updating the docstrings to use the API instead?

wilsonmr and others added 2 commits February 23, 2021 17:18
Co-authored-by: Rosalyn Pearson <33020850+RosalynLP@users.noreply.github.com>
…fication and updated docstrings to recommend API
@wilsonmr
Copy link
Copy Markdown
Contributor Author

OK So I updated docstrings to use API and I also changed a couple of examples in the docs to use more complicated dataset settings to emphasize that not all datasets are like NMC, I didn't completely remove the NMC examples because I thought it was nice to have variety.

@Zaharid
Copy link
Copy Markdown
Contributor

Zaharid commented Feb 23, 2021

Is it me or the code is starting to look good?

@Zaharid Zaharid merged commit 3538dd8 into master Feb 24, 2021
@Zaharid Zaharid deleted the restruct-pydat-alt branch February 24, 2021 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants