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

123 mac m1 installation #164

Merged
merged 10 commits into from
Oct 16, 2023
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,19 @@ 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`.
2. Virtual python workspace: `conda`.

We recommend using python version above 3.10.
A `environment.yml` file is provided to easily create a virtual environment
named `sopht-env`. The user may modify the name as necessary.

```bash
conda create --name sopht-env
conda env create -f environment.yml
conda activate sopht-env
conda install pip
```

3. Setup [`poetry`](https://python-poetry.org) and `dependencies`!
3. Set up `dependencies`!

```bash
make poetry-download
make install
make pre-commit-install
```
Expand All @@ -48,7 +47,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 +63,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

7 changes: 7 additions & 0 deletions environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: sopht-env
channels:
- defaults
dependencies:
- python=3.10.*
- pip
- conda-forge::poetry>=1.0.0,<1.6.0
Loading
Loading