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

Update dev env instructions #2990

Draft
wants to merge 3 commits into
base: latest
Choose a base branch
from
Draft

Update dev env instructions #2990

wants to merge 3 commits into from

Conversation

luizirber
Copy link
Member

@luizirber luizirber commented Feb 10, 2024

Close #2793

@luizirber luizirber force-pushed the lirber/pixi branch 2 times, most recently from e60ea44 to f759c17 Compare February 10, 2024 23:51
Copy link

codecov bot commented Feb 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.88%. Comparing base (20e6195) to head (92c50d5).

Additional details and impacted files
@@           Coverage Diff           @@
##           latest    #2990   +/-   ##
=======================================
  Coverage   86.88%   86.88%           
=======================================
  Files         136      136           
  Lines       15543    15543           
  Branches     2637     2637           
=======================================
  Hits        13505    13505           
  Misses       1736     1736           
  Partials      302      302           
Flag Coverage Δ
hypothesis-py 25.44% <ø> (ø)
python 92.87% <ø> (ø)
rust 61.45% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@luizirber luizirber force-pushed the lirber/pixi branch 8 times, most recently from 9cd3fec to 1878403 Compare February 11, 2024 01:18
@ctb
Copy link
Contributor

ctb commented Feb 11, 2024

I mean I've loved pixi, the little bit I've used it; but do we really want to switch dev instructions over to it?

@ctb
Copy link
Contributor

ctb commented Feb 11, 2024

(I guess I'm not immediately seeing a big reason. But I am happy to be convinced :)

@luizirber
Copy link
Member Author

I mean I've loved pixi, the little bit I've used it; but do we really want to switch dev instructions over to it?

We have the drift on install instructions (as pointed in #2707) because what we document is not quite we run in CI.

I was going for setting up pixi and using the pixi.lock file to also install a conda environment if pixi is not available, but conda-lock and pixi diverged on the lockfile format. Maybe they will converge back, but for now they are incompatible.

It is still fine to have conda instructions and say "look at the [dependencies] section in pixi.toml and run conda create with that", but we start getting into a lot of duplicate dependency definitions... We could have an environment.yml and keep it in sync with pixi.toml too, if that's easier.

(I guess I'm not immediately seeing a big reason. But I am happy to be convinced :)

I like pixi because it is so much easier to install than conda, and doesn't mess with shell env vars. And if you're in a system that has conda installed but doesn't allow extra software installation, you can still conda install -c conda-forge pixi and have it available.

Drawback is that conda is much more stable, pixi has been moving pretty quickly and might be hard to keep up (but we do have CI setup in this PR).

It boils down to which is the easiest one to teach and get started, pixi seems easier because it's one file to download and pixi shell to get started, but conda can be more general-purpose and transfer better to other situations?

All that said, I don't use conda or pixi for sourmash development, so better to someone that does use to chime in 🙃

new features, running tests and code quality checks.
Here are some suggestions on how to set them up (note: you only need one =])

### Using mamba (conda alternative)
::::{tab-set}
Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

I love it!

@luizirber luizirber changed the title Use pixi for conda-based dev env Update dev env instructions Feb 12, 2024
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.

explore pixi for sourmash
2 participants