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

fix links, outdated info on conda-lock and libmamba #153

Merged
merged 1 commit into from
Sep 5, 2023
Merged

fix links, outdated info on conda-lock and libmamba #153

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 5 additions & 36 deletions jupyterbook/content/ioos_installation_conda.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

For IOOS Python/R/Julia users we recommend the free
[Miniforge](https://github.com/conda-forge/miniforge) distribution,
a lightweight version of the [Anaconda Scientific Python Distribution](https://store.continuum.io/cshop/anaconda/) with the conda-forge channel pre-configured.
a lightweight version of the [Anaconda Scientific Python Distribution](https://www.anaconda.com/download) with the conda-forge channel pre-configured.
While the full Anaconda distribution will also work,
it is faster to install Miniforge and you can install only the packages you need.
If for some reason you decide later that you want the full Anaconda distribution,
Expand All @@ -11,7 +11,7 @@ you can install it by typing `conda install -c defaults anaconda`.
Note that if you have the Anaconda Distribution,
or any other installation,
in your machine you may want to follow
[these uninstall instructions](https://docs.anaconda.com/anaconda/install/uninstall)
[these uninstall instructions](https://docs.anaconda.com/free/anaconda/install/uninstall/)
before proceeding.

## Install
Expand Down Expand Up @@ -44,35 +44,6 @@ bash Miniforge-$(uname)-$(uname -m).sh
and use all the default options,
except for the license agreement where you must actively change it to `yes`.

## Add mamba solver
Copy link
Member Author

Choose a reason for hiding this comment

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

This is unnecessary now that libmamba is the default solver.


The first thing we will do is to install the mamba solver and add it to our `.condarc`.
This make the faster mamba solver default in our installations.

```
conda install --name base conda-libmamba-solver --yes
conda config --set solver libmamba
```

If that worked you should see:

```
***

NOTE: You are using the EXPERIMENTAL libmamba solver integration.

If something is not working as expected, please:

1. Go to https://github.com/conda/conda/issues/new/choose
2. Choose the "Libmamba Solver Feedback (Experimental Feature)" option

Thank you for your help!

***
```

For more info see: [https://github.com/conda/conda-libmamba-solver](https://github.com/conda/conda-libmamba-solver).

## Create the IOOS conda environment

Download the [environment.yml](https://raw.githubusercontent.com/ioos/ioos_code_lab/main/.binder/environment.yml),
Expand Down Expand Up @@ -160,7 +131,7 @@ but the binary libraries they depend on.
So it's easier than `pip install` and, thanks to binary relocation,
more powerful than python wheels.
System-level installation of libraries and admin privileges are not required.
Check out [Travis Oliphant's blog piece](http://technicaldiscovery.blogspot.com/2013/12/why-i-promote-conda.html) for more info.
Check out [Travis Oliphant's blog piece](https://technicaldiscovery.blogspot.com/2013/12/why-i-promote-conda.html) for more info.

## How to get help

Expand All @@ -177,14 +148,12 @@ For example, if you are seeing kernel errors like the one below.

1. If you believe that only your environment is broken you can follow the [update environment](#updating-the-ioos-environment) instructions from above;
1. Sometimes conda updates can break backwards compatibility and updating is broken. In those cases remove the Miniforge3 directory and perform a fresh install of the new version.
1. In rare cases you may want to install a frozen version of the environment. Like, you need the exact same version that is running on our CIs. You can accomplish that by [downloading the lock file your system](https://github.com/ioos/ioos_code_lab/tree/main/.binder) and issuing the command:
1. In rare cases you may want to install a frozen version of the environment. Like, you need the exact same version that is running on our CIs. You can accomplish that by [downloading the lock file](https://github.com/ioos/ioos_code_lab/raw/main/.binder/conda-lock.yml) and issuing the command:

```shell
conda create --name IOOS --file .binder/conda-linux-64.lock
conda create --name IOOS --file .binder/conda-lock.yml
```

Be sure to change `linux-64` in the lock file name according to your system (`win-64` or `osx-64`).

Comment on lines -180 to -187
Copy link
Member Author

Choose a reason for hiding this comment

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

We are using the platform agnostic lockfile. We no longer need platform specific instructions.

### conda-lock

Locking environments can be useful for reproducibility,
Expand Down