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

Remove pytables as a conda dependency #104

Merged
merged 3 commits into from
Jan 23, 2024
Merged

Conversation

niksirbi
Copy link
Member

@niksirbi niksirbi commented Jan 22, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

Currently, we have a two-step installation process:

  1. Create a conda environment, with pytables installed:
conda create -n movement-env -c conda-forge python=3.10 pytables
conda activate movement-env
  1. Install movement itself.
pip install movement

We would like to simplify it to a single step, so users can simply pip install movement. That can be preceded by conda create -n movement-env python=3.10, if they want to install it in a fresh environment (which we still recommend).

What does this PR do?

As per @willGraham01's suggestion, we now require pandas[hdf5] instead of vanilla pandas. See #91 for more details on this.

References

Closes #91

How has this PR been tested?

Tested locally on an M2 Mac and on CI across platforms.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

The installation instructions have been updated accordingly. We still recommend using a conda environment (albeit without pytables), and after that it's simply pip install movement.

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality (installation already covered in CI)
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@niksirbi niksirbi added the enhancement New optional feature label Jan 22, 2024
Copy link

codecov bot commented Jan 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9ee30c7) 99.12% compared to head (1f99e10) 99.12%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #104   +/-   ##
=======================================
  Coverage   99.12%   99.12%           
=======================================
  Files           8        8           
  Lines         458      458           
=======================================
  Hits          454      454           
  Misses          4        4           

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

Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@niksirbi niksirbi requested a review from lochhh January 23, 2024 12:03
@niksirbi niksirbi marked this pull request as ready for review January 23, 2024 12:03
Copy link
Collaborator

@lochhh lochhh left a comment

Choose a reason for hiding this comment

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

Thanks! @niksirbi LGTM 🚀

@lochhh lochhh merged commit 5cd1922 into main Jan 23, 2024
24 checks passed
@lochhh lochhh deleted the remove-pytables-conda-dependency branch January 23, 2024 13:52
@niksirbi niksirbi mentioned this pull request Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New optional feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Require pandas[hdf5] instead of vanilla pandas
2 participants