Skip to content

Commit 355fec4

Browse files
author
David Turner
committed
Added mention of the optional contextlib2 dependency (well, optional for Python 3.11 and up, required for 3.10 and below). For issue #1524
1 parent f5a31a4 commit 355fec4

2 files changed

Lines changed: 5 additions & 0 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ conda activate <YOUR ENVIRONMENT NAME GOES HERE>
6161
pip install pyabel==0.9
6262
```
6363

64+
> [!IMPORTANT]
65+
> For Python 3.10 and earlier, the optional dependency [`contextlib2`](https://pypi.org/project/contextlib2/) must be installed.
66+
6467
## Required Dependencies
6568
XGA depends on two non-Python pieces of software:
6669
* XMM's Science Analysis System (SAS) - Version 17.0.0, but other versions should be largely compatible with the

docs/source/install.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ We also provide a Conda lock file in the conda_envs directory (see `conda-lock G
5050
conda activate <YOUR ENVIRONMENT NAME GOES HERE>
5151
pip install pyabel==0.9
5252
53+
.. important::
54+
For Python 3.10 and earlier, the optional dependency [`contextlib2`](https://pypi.org/project/contextlib2/) must be installed.
5355

5456
Required Dependencies
5557
---------------------

0 commit comments

Comments
 (0)