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.

Sign up for GitHub

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

Jump to bottom

docs(contribute): include instructions to use Pixi #10504

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs(contribute): include instructions to use Pixi #10504

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1022a89
docs(contribute): include instructions to use Pixi
deepyaman Nov 16, 2024
ad5f6c4
docs(contribute): dedent the callout to fix format
deepyaman Nov 17, 2024
95e8c44
docs(contribute): give up on numbered list callout
deepyaman Nov 17, 2024
3452844
docs(contribute): move note on Pixi init artifacts
deepyaman Nov 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 35 additions & 17 deletions docs/contribute/01_environment.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ the `conda/mamba` setup and refer to the comment related to `arm64`
architectures.
:::

## Conda/Mamba
## Conda/Mamba/Pixi

### Support matrix [^conda-callout]

Expand All @@ -45,6 +45,10 @@ managers = {
"name": "Mamba",
"url": "https://github.com/mamba-org/mamba",
},
"pixi": {
"name": "Pixi",
"url": "https://pixi.sh/latest/",
},
}

for manager, params in managers.items():
Expand All @@ -58,7 +62,10 @@ for manager, params in managers.items():
print(f"1. Install `gh`")
print()
print(" ```sh")
print(f" {manager} install -c conda-forge gh")
if manager == "conda" or manager == "mamba":
print(f" {manager} install -c conda-forge gh")
elif manager == "pixi":
print(f" {manager} global install gh")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't do this because I don't use gh, but wanted to keep things consistent...

print(" ```")
print()
print(f"1. Fork and clone the ibis repository:")
Expand All @@ -67,37 +74,48 @@ for manager, params in managers.items():
print(" gh repo fork --clone --remote ibis-project/ibis")
print(" ```")
print()
print(f"1. Create a Conda environment using `environment.yml`")
print(f"1. Create a {name} environment using `environment.yml`")
print()
print(" ```sh")
print(" cd ibis")
print(f" {manager} env create --file conda/environment.yml")
if manager == "conda" or manager == "mamba":
print(f" {manager} env create --file conda/environment.yml")
elif manager == "pixi":
print(f" {manager} init --import conda/environment.yml")
print(" ```")
print()
if manager == "conda" or manager == "mamba":
print()
print(
" If you're using arm64 architecture (Mac M1/M2), use "
"`conda/environment-arm64.yml` for setting up a dev environment for all the "
"backends that are possible to install excluding Flink; use "
"`conda/environment-arm64-flink.yml` for setting up a dev environment for all "
"the backends that are possible to install including Flink. The reason to have "
"two separate environments is because `apache-flink` forces `pyarrow` to "
"downgrade to 11.0, which causes conflicts in other backends."
)
print(
" If you're using arm64 architecture (Mac M1/M2), use "
"`conda/environment-arm64.yml` for setting up a dev environment for all the "
"backends that are possible to install excluding Flink; use "
"`conda/environment-arm64-flink.yml` for setting up a dev environment for all "
"the backends that are possible to install including Flink. The reason to have "
"two separate environments is because `apache-flink` forces `pyarrow` to "
"downgrade to 11.0, which causes conflicts in other backends."
)
print()
if manager == "pixi":
print(" ::: {.callout-note}")
print(" This command will initialize a `pixi.toml` file and also modify ")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Alternatively, we could provide Pixi configuration in pyproject.toml (or pixi.toml), but this would be more involved to keep in sync; this approach worked well enough for me so far, with minimal effort.

print(" the `.gitignore` to prevent Pixi configuration from being added to ")
print(" `git`.")
print(" :::")
print()
print(f"1. Activate the environment")
print()
print(" ```sh")
print(f" {manager} activate ibis-dev")
if manager == "conda" or manager == "mamba":
print(f" {manager} activate ibis-dev")
elif manager == "pixi":
print(f" {manager} shell")
print(" ```")
print()
print(
f"1. Install your local copy of `ibis` into the {manager.capitalize()} environment"
)
print()
print(" ```sh")
print(" pip install -e .")
print(" uv pip install -e .")
print(" ```")
print()
```
Expand Down
Loading