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

Install on OSX #1257

Closed
wants to merge 5 commits into from
Closed

Install on OSX #1257

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8aa5534
added environment file for OSX
valeriupredoi Aug 22, 2019
fe4a2ce
added instructions how to install on OSX
valeriupredoi Aug 22, 2019
e8da65a
removed osx specific env file
valeriupredoi Sep 11, 2019
5ae5f81
adjusted instructions to reflect the new noarch package
valeriupredoi Sep 11, 2019
d8496d2
Merge branch 'version2_development' into version2_development_installOSX
valeriupredoi Sep 11, 2019
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
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,23 @@ To install in development mode, follow these instructions.
- If you log into a cluster or other device via `ssh` and your origin machine sends the `locale` environment via the `ssh` connection, make sure the environment is set correctly, specifically `LANG` and `LC_ALL` are set correctly (for GB English UTF-8 encoding these variables must be set to `en_GB.UTF-8`; you can set them by adding `export LANG=en_GB.UTF-8` and `export LC_ALL=en_GB.UTF-8` in your origin or login machines' `.profile`)
- Do not run `conda update --update-all` in the `esmvaltool` environment since that will update some packages that are pinned to specific versions for the correct functionality of the environment.

## Getting started on MacOS OSX-64
To install on a MacOS you will have to perform the following installation procedure:

**WARNING**
The Mac OSX installation is not being continuously tested via CircleCI! If you notice any problems please report them on GitHub.

- Download and install Anaconda [for OSX](https://repo.anaconda.com/archive/Anaconda3-2019.07-MacOSX-x86_64.sh)(install by e.g. `bash Anaconda3-2019.07-MacOSX-x86_64.sh` or whatever the installer is called);
- Answer yes when, at the end of the installation, Anaconda asks you to initialize the installation in your `.bash_profile`;
- Update conda: `conda update -y conda`
- Clone the ESMValTool public github repository: `git clone git@github.com:ESMValGroup/ESMValTool`, or one of the private github repositories (e.g. `git clone git@github.com:ESMValGroup/ESMValTool-private`)
- Go to the esmvaltool directory: `cd ESMValTool`
- Create the esmvaltool conda environment `conda env create --name esmvaltool --file environment.yml`
- Activate the esmvaltool environment: `conda activate esmvaltool`
- Install in development mode: `pip install -e '.[develop]'`. If you are installing behind a proxy that does not trust the usual pip-urls you can declare them with the option `--trusted-host`, e.g. `pip install --trusted-host=pypi.python.org --trusted-host=pypi.org --trusted-host=files.pythonhosted.org -e .[develop]`
- All other R or Julia packages install just as instructed above
- Note that the installation instructions are identical to the Linux installation due to the package being architecture agnostic (specified by the `noarch` label). Also note that, depending on the `gcc` compiler the Apple OSX has, it may not be possible to install the R packages; you may be able to do that with compatible `gcc` versions.

## Using the development version of the ESMValTool Core package

If you need the latest developments of the ESMValTool Core package,
Expand Down