Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate HIF with more of XGI #613

Merged
merged 20 commits into from
Dec 2, 2024
Merged

Integrate HIF with more of XGI #613

merged 20 commits into from
Dec 2, 2024

Conversation

nwlandry
Copy link
Collaborator

@nwlandry nwlandry commented Oct 28, 2024

In preparation for converting XGI-DATA to the HIF standard, this PR does the following:

  • Moves the internals of write_hif and read_hif to the convert module as to_hif_dict and from_hif_dict.
  • Modifies load_xgi_data to (1) allow HIF format as an input and (2) download/read files in HIF format
  • Adds a warning in the write_json and read_json functions notifying users that they are now deprecated.

@nwlandry nwlandry marked this pull request as draft October 28, 2024 17:00
Copy link

codecov bot commented Oct 28, 2024

Codecov Report

Attention: Patch coverage is 94.73684% with 7 lines in your changes missing coverage. Please review.

Project coverage is 93.36%. Comparing base (b74205a) to head (84588a9).
Report is 22 commits behind head on main.

Files with missing lines Patch % Lines
xgi/readwrite/xgi_data.py 33.33% 4 Missing ⚠️
xgi/readwrite/hif.py 95.00% 2 Missing ⚠️
xgi/convert/hif_dict.py 98.78% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #613      +/-   ##
==========================================
+ Coverage   93.24%   93.36%   +0.12%     
==========================================
  Files          62       64       +2     
  Lines        4735     4962     +227     
==========================================
+ Hits         4415     4633     +218     
- Misses        320      329       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nwlandry nwlandry marked this pull request as ready for review October 29, 2024 19:13
@nwlandry
Copy link
Collaborator Author

This partially addresses #605.

@nwlandry nwlandry requested a review from maximelucas October 30, 2024 13:25
@nwlandry
Copy link
Collaborator Author

@maximelucas --- are you able to review this?

@maximelucas
Copy link
Collaborator

I can do it yes, if not this week, early next week.
From a quick look already, it would probably be worth adding a general description of the HIF somewhere? Maybe a page in the online docs, or on the existing XGI-DATA page?

HOW_TO_CONTRIBUTE.md Outdated Show resolved Hide resolved
@nwlandry
Copy link
Collaborator Author

I can do it yes, if not this week, early next week. From a quick look already, it would probably be worth adding a general description of the HIF somewhere? Maybe a page in the online docs, or on the existing XGI-DATA page?

Great point. I will add this to the XGI-DATA page.

@nwlandry
Copy link
Collaborator Author

nwlandry commented Dec 2, 2024

@maximelucas I think I addressed all your comments!

@nwlandry nwlandry merged commit c356994 into main Dec 2, 2024
21 of 23 checks passed
@nwlandry nwlandry deleted the add-hif-convert branch December 2, 2024 21:21
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.

2 participants