Skip to content

Commit 4756352

Browse files
committed
Update installation instructions and CI workflow for macOS support
1 parent 31fff00 commit 4756352

2 files changed

Lines changed: 26 additions & 8 deletions

File tree

.github/workflows/pypi-test.yml

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ jobs:
4848
- name: Init pixi project
4949
run: pixi init easydiffraction
5050

51+
- name: Set the minimum system requirements
52+
run: pixi project system-requirements add macos 14.0
53+
5154
- name: Add Python 3.14 from Conda
5255
working-directory: easydiffraction
5356
run: pixi add "python=3.14"
@@ -58,22 +61,25 @@ jobs:
5861
pixi add gsl
5962
pixi add --platform osx-arm64 libcxx
6063
61-
- name: Add easydiffraction from PyPI
62-
working-directory: easydiffraction
63-
run: pixi add --pypi "easydiffraction"
64-
65-
- name: Add dev dependencies from PyPI
64+
- name: Add pycrysfml calculator from custom PyPI index
6665
working-directory: easydiffraction
67-
run: pixi add --pypi pytest pytest-xdist
66+
run: |
67+
echo '' >> pixi.toml
68+
echo '[pypi-dependencies]' >> pixi.toml
69+
echo 'pycrysfml = { version = ">=0.2.1", index = "https://easyscience.github.io/pypi/" }' >> pixi.toml
6870
69-
- name: Add Pixi task as a shortcut
71+
- name: Add easydiffraction (with dev dependencies) from PyPI
7072
working-directory: easydiffraction
71-
run: pixi task add easydiffraction "python -m easydiffraction"
73+
run: pixi add --pypi "easydiffraction[dev]"
7274

7375
- name: Run unit tests to verify the installation
7476
working-directory: easydiffraction
7577
run: pixi run python -m pytest ../tests/unit/ --color=yes -v
7678

79+
- name: Run functional tests to verify the installation
80+
working-directory: easydiffraction
81+
run: pixi run python -m pytest ../tests/functional/ --color=yes -v
82+
7783
- name: Run integration tests to verify the installation
7884
working-directory: easydiffraction
7985
run: pixi run python -m pytest ../tests/integration/ --color=yes -n auto

docs/docs/installation-and-setup/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,22 @@ This section describes the simplest way to set up EasyDiffraction using
6262
pixi init easydiffraction
6363
cd easydiffraction
6464
```
65+
- If you are on macOS, set the minimum system requirements:
66+
```txt
67+
pixi project system-requirements add macos 14.0
68+
```
6569
- Set the Python version for the Pixi environment (e.g., 3.14):
6670
```txt
6771
pixi add python=3.14
6872
```
73+
- Add GNU Scientific Library (required for PDF calculations):
74+
```txt
75+
pixi add gsl
76+
```
77+
- If you are on macOS, add libc++ (required for PDF calculations):
78+
```txt
79+
pixi add --platform osx-arm64 libcxx
80+
```
6981
- Add EasyDiffraction to the Pixi environment from PyPI:
7082
```txt
7183
pixi add --pypi easydiffraction

0 commit comments

Comments
 (0)