Port causality from internal quick-tips repo to open-source GitHub #38
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
julienschuermans
approved these changes
Oct 1, 2022
There was a problem hiding this comment.
Really sorry for the delay. I have some tiny remarks, but other than that this PR looks good to go:
- Storing the data in a
.picklefile is probably not the best idea. - By copying pycausality and adding wrappers this PR adds a lot of code. Next time we should check if a "quick tip" can be smaller in size. The reusable code could be hosted in a separate codebase.
- There are a lot of items in the
requirements.txt. I guess most of those are "secondary"? Maybe next time let's only add the direct dependencies.
| ## Purpose of this folder | ||
| We advocate to use the [PyCausality](https://pypi.org/project/PyCausality/) package when working with Transfer Entropy. | ||
| The code itself is not maintained anymore but still works well. | ||
| Because the pip package might become/is unstable, we copied the source code and created a wrapper around it. |
There was a problem hiding this comment.
Is the pip package actually unstable? Or is the main reason here that our wrapper adds a lot of value?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to: