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

123 mac m1 installation #164

Merged
merged 10 commits into from
Oct 16, 2023
Merged

123 mac m1 installation #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a575ec4
fix: fix m1 sopht installation issue with modifed pyfftw and pystenci…
sy-cui Oct 2, 2023
e5ed18d
feat: environment.yml file for environment initialization
sy-cui Oct 2, 2023
210f4a5
update README.md
sy-cui Oct 2, 2023
164765a
fix: update poetry.lock to reflect changes in pystencils
sy-cui Oct 3, 2023
98e9b4c
refactor: make pystencils and pyfftw installation os-dependent
sy-cui Oct 3, 2023
9c45da1
Merge branch 'main' into 123_mac_m1_installation
bhosale2 Oct 8, 2023
ecca137
fix: remove conda-forge channel requirement from poetry installation
sy-cui Oct 11, 2023
457cbfd
refactor: remove environment.yml and install poetry using pip
sy-cui Oct 11, 2023
44e96cf
doc: udpate installation instruction in README.md
sy-cui Oct 11, 2023
f7d8b62
doc: update README.md with instructions for MacOS installation
sy-cui Oct 16, 2023
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
8 changes: 4 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
PYTHON := python3
PYTHONPATH := `pwd`
#* Poetry
.PHONY: poetry-download
poetry-download:
curl -sSL https://install.python-poetry.org/ | $(PYTHON) -
.PHONY: poetry-install
poetry-install:
pip install "poetry>=1.0.0,<1.6.0"

.PHONY: poetry-remove
poetry-remove:
curl -sSL https://install.python-poetry.org/ | $(PYTHON) - --uninstall
pip uninstall poetry

#* Installation
.PHONY: install
Expand Down
24 changes: 15 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,27 @@ the project, although most of the important commands will be provided in `Makefi

First **create the fork repository and clone** to your local machine.

2. Virtual python workspace: `conda`, `pyenv`, or `venv`.

We recommend using python version above 3.10.
2. Set up virtual python workspace: `conda`.

```bash
conda create --name sopht-env
conda create -n sopht-env
conda activate sopht-env
conda install pip
conda install python=3.10
```
3. (MacOS) System-wide installed dependencies

3. Setup [`poetry`](https://python-poetry.org) and `dependencies`!
On MacOS (especially M-series with ARM64 architecture), we require a Homebrew installed
`fftw` library and a working `clang++` compiler with `OpenMP` support. If these requirements
are not met, we recommend
```bash
brew install llvm
brew install fftw
```

4. Set up `dependencies`!

```bash
make poetry-download
make poetry-install
make install
make pre-commit-install
```
Expand All @@ -48,7 +55,7 @@ We ask that any publications which use SophT cite as following:
Songyuan Cui and
Fan Kiat Chan and
Mattia Gazzola},
title = {{Scalable One-stop Platform for Hydroelastic Things
title = {{Scalable One-stop Platform for Hydroelastic Things
(SOPHT)}},
month = feb,
year = 2023,
Expand All @@ -64,4 +71,3 @@ We ask that any publications which use SophT cite as following:

[link-doi]: https://zenodo.org/badge/latestdoi/498451510
[link-CI]: https://github.com/SophT-Team/SophT/actions

Loading
Loading