Skip to content

Commit

Permalink
docs: update environment setup instructions (#8476)
Browse files Browse the repository at this point in the history
<!--
Thanks for taking the time to contribute to Ibis!

Please ensure that your pull request title matches the conventional
commits
specification: https://www.conventionalcommits.org/en/v1.0.0/
-->

## Description of changes

Update environment setup instructions for `conda`.
  • Loading branch information
chloeh13q authored Feb 27, 2024
1 parent 103dc68 commit a18ab29
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions docs/contribute/01_environment.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ managers = {
"mamba": {
"name": "Mamba",
"url": "https://github.com/mamba-org/mamba",
}
},
}
for manager, params in managers.items():
Expand All @@ -101,16 +101,30 @@ for manager, params in managers.items():
print()
print(" ```sh")
print(" cd ibis")
print(f" {manager} env create --file environment.yml")
print(f" {manager} env create --file conda/environment.yml")
print(" ```")
print()
if manager == "conda":
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()
print(f"1. Activate the environment")
print()
print(" ```sh")
print(f" {manager} activate ibis-dev")
print(" ```")
print()
print(f"1. Install your local copy of `ibis` into the {manager.capitalize()} environment")
print(
f"1. Install your local copy of `ibis` into the {manager.capitalize()} environment"
)
print()
print(" ```sh")
print(" pip install -e '.[all]'")
Expand Down

0 comments on commit a18ab29

Please sign in to comment.