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

Install instructions for ARM-based Macs #16

Merged
merged 4 commits into from
Nov 23, 2022
Merged

Conversation

SeaCelo
Copy link
Collaborator

@SeaCelo SeaCelo commented Nov 11, 2022

This PR:

  • It points to the proper distribution of Anaconda (ARM), which also installs the correct distribution of Python (ARM).
  • Creates a environment-M1.yml file that has the correct dependencies needed for installing on ARM Macs, as described in this comment.
  • Updates the Read Me with instructions specific for those installing on ARM-based Macs: 1) don't install the mkl dependency, and 2) install the ogcore dependency as a separate step.

This solves #15

On ARM Macs (M1, M2) it is better to avoid the MKL library.
Added installation instructions for ARM-based Macs, including a dedicated environment-M1.yml file.
@SeaCelo SeaCelo added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 11, 2022
@SeaCelo SeaCelo requested a review from rickecon November 11, 2022 20:34
- conda-forge
dependencies:
- python>=3.7.7, <=3.9.12 # This restriction can be removed as soon as these packages support Python 3.10
#- mkl>=2020.2 ## this fails on M1 Mac: "ResolvePackageNotFound: - mkl[version='>=2020.2']"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
#- mkl>=2020.2 ## this fails on M1 Mac: "ResolvePackageNotFound: - mkl[version='>=2020.2']"
#- openssl=1.1.1 #to ensure compatibility with the UN Population API

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

To address an incompatibility with openssl version 3
Discussion here

Copy link
Collaborator

Choose a reason for hiding this comment

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

@SeaCelo. Let's update the name of the environment-M1.yml in line 1 to ogzaf-M1-dev.

Comment on lines +6 to 7
- mkl>=2020.2
- numpy<=1.21.2 # This restriction can be removed as soon as Numba supports NumPy 1.22
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
- mkl>=2020.2
- numpy<=1.21.2 # This restriction can be removed as soon as Numba supports NumPy 1.22
- mkl>=2020.2
- openssl=1.1.1 # To ensure compatibility with the UN Population API
- numpy<=1.21.2 # This restriction can be removed as soon as Numba supports NumPy 1.22

@SeaCelo SeaCelo self-assigned this Nov 16, 2022
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@@ -0,0 +1,34 @@
name: ogzaf-dev
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
name: ogzaf-dev
name: ogzaf-M1-dev

@rickecon
Copy link
Collaborator

@SeaCelo. Great. This looks ready to merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants