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

feat: Make notebooks runnable on previous data #11

Merged
merged 5 commits into from
Apr 17, 2024
Merged

Conversation

matthewfeickert
Copy link
Contributor

@matthewfeickert matthewfeickert commented Apr 1, 2024

Purpose

  • Add a .gitkeep for the data/ directory and also add it to .gitignore.
  • Fix typo and JSON serialization issues with previous notebooks to allow them to be run from a fresh kernel (using data from Gist previous to 2024-03-31).
  • Use pathlib.Path to avoid potential errors and allow changing of output directory to be at the top level of the project.
  • Add pixi task runner commands as well as instructions to the README.

As this PR does more than 1 thing, it isn't very atomic (and so less fun to review). It can be easily split into multiple more atomic PRs though, which I'd be happy to do if that's nicer.

We can also discuss in the 2024-04-01 Program meeting.

(PR was done on plane, but for some reason couldn't get pushed out over plane WiFi, so had to wait till I got to a coffee shop.)

Does this introduce a breaking change?

[ ] Yes
[x] No

Pull Request Type

What kind of change does this Pull Request introduce?

[x] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[ ] Other... Please describe:

* Retain the data directory to ensure it exists.
* Add the data/ directory to .gitignore
* Correct typo: 'track_id' -> 'track_ids'
* Use `tolist` to make object JSON serializable.
   - NumPy arrays can't be JSON serialized.
@matthewfeickert matthewfeickert requested a review from guenp April 1, 2024 10:56
@matthewfeickert matthewfeickert self-assigned this Apr 1, 2024
@matthewfeickert matthewfeickert changed the title Feat/make runnable feat: Make notebooks runnable on previous data Apr 1, 2024
* Avoids potential errors and warnings and removes
  OS dependent paths.
* Add pre-processing and assignments task.
* Add run instructions to README.
Copy link
Member

@guenp guenp left a comment

Choose a reason for hiding this comment

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

Looks great, thank you!

@guenp guenp merged commit 6647435 into main Apr 17, 2024
2 checks passed
@guenp guenp deleted the feat/make-runnable branch April 17, 2024 21:23
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