Skip to content

Commit 55d4b5c

Browse files
committed
update install information for latest version
1 parent 5648e3a commit 55d4b5c

File tree

2 files changed

+28
-17
lines changed

2 files changed

+28
-17
lines changed

INSTALL.md

+25-14
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Installing PySCeS
22

3-
Binary install packages for all three OSs and Python versions 3.6-3.9 are provided.
4-
Anaconda users can conveniently install PySCeS with:
3+
Binary install packages for all three OSs and recent Python versions are
4+
provided. Anaconda packages are available for 64-bit Windows and Linux, as well as
5+
macOS *x86_64* architecture. Apple Silicon (*arm64*) macOS users should install with
6+
`pip` (see below). Anaconda users can conveniently install PySCeS with:
57

68
```bash
79
$ conda install -c conda-forge -c pysces pysces
@@ -11,7 +13,9 @@ Any dependencies will be installed automatically, including the optional depende
1113
*Assimulo*, *ipyparallel* and *libSBML*.
1214

1315
Alternatively, you can use *pip* to
14-
install PySCeS from PyPI. Core dependencies will be installed automatically.
16+
install PySCeS from PyPI. Core dependencies will be installed automatically. Wheels
17+
are available for 64-bit Windows and Linux, as well as macOS architectures *x86_64* and
18+
*arm64* (starting from PySCeS version 1.2.0).
1519

1620
```bash
1721
$ pip install pysces
@@ -30,7 +34,7 @@ To install the optional dependences:
3034
> very limited number of Python versions and operating systems on PyPI.
3135
> **This is not guaranteed to work!** If you require Assimulo, the conda
3236
> install is by far the easier option as up-to-date binaries are supplied
33-
> for all OS and recent Python versions.
37+
> for all OSs and recent Python versions.
3438
3539
For more information on installing and configuring PySCeS please see the
3640
[PySCeS User Guide](https://github.com/PySCeS/pysces-documentation/blob/main/source/userguide_doc.rst#installing-and-configuring)
@@ -42,17 +46,25 @@ installation from source. This requires Fortran and C compilers.
4246

4347
### Windows build
4448

45-
The fastest way to build your own copy of PySCeS is to use Anaconda Python.
49+
The fastest way to build your own copy of PySCeS is to use Anaconda for
50+
installing Python and the required libraries. In addition, the *RTools* compiler
51+
toolchain is required.
4652

4753
* Download and install
48-
[Anaconda for Python 3](https://www.anaconda.com/products/individual#Downloads)
54+
[Anaconda for Python 3](https://www.anaconda.com/download#Downloads)
4955
* Obtain [Git for Windows](https://git-scm.com/download/win)
56+
* Obtain the *RTools* compiler toolchain (**version 4.0.0.20220206**), either using
57+
[Chocolatey](https://chocolatey.org/install)
58+
(`choco install rtools -y --version=4.0.0.20220206`) or by
59+
[direct download](https://github.com/r-windows/rtools-installer/releases/download/2022-02-06/rtools40-x86_64.exe)
60+
- Install in `C:\rtools40` (Chocolatey automatically installs to this path)
61+
- Add `c:\rtools40\ucrt64\bin` and `c:\rtools40\usr\bin` to the system `PATH`
5062
* Create a PySCeS environment using conda and activate it:
5163

5264
```bash
53-
$ conda create -n pyscesdev -c conda-forge python=3.8 numpy scipy \
65+
$ conda create -n pyscesdev -c conda-forge python=3.11 numpy=1.26 scipy \
5466
matplotlib sympy packaging pip wheel ipython python-libsbml \
55-
fortran-compiler assimulo scikit-build
67+
assimulo meson meson-python ninja
5668
$ conda activate pyscesdev
5769
```
5870

@@ -63,11 +75,10 @@ $ conda activate pyscesdev
6375
(pyscesdev)$ cd pysces-src
6476
```
6577

66-
* Now you can build and install PySCeS into the pyscesdev environment
78+
* Now you can build and install PySCeS into the *pyscesdev* environment
6779

6880
```bash
69-
(pyscesdev)$ python setup.py build
70-
(pyscesdev)$ python setup.py install
81+
(pyscesdev)$ pip install --no-deps --no-build-isolation .
7182
```
7283

7384
### Linux build
@@ -80,7 +91,7 @@ Clone the source from Github as described above, change into the source director
8091
run:
8192

8293
```bash
83-
$ python setup.py install
94+
$ pip install .
8495
```
8596

8697
### macOS build
@@ -92,7 +103,7 @@ compilers may be installed via [Xcode](https://developer.apple.com/xcode). Clone
92103
source from Github as described above, change into the source directory and run:
93104

94105
```bash
95-
$ python setup.py install
106+
$ pip install .
96107
```
97108

98-
© Brett G. Olivier & Johann M. Rohwer, August 2021
109+
© Johann M. Rohwer & Brett G. Olivier, January 2024

LATEST.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git clone git@github.com:PySCeS/pysces.git
99
```
1010

1111
PySCeS binaries for release versions are available from PyPI and the Anaconda.org
12-
for 64-bit Windows, Linux and macOS.
12+
repository for 64-bit Windows, Linux and macOS.
1313

1414
**For PyPI:**
1515

@@ -20,7 +20,7 @@ pip install pysces
2020
**For Anaconda:**
2121

2222
```
23-
conda install -c sbmlteam -c pysces pysces
23+
conda install -c conda-forge -c pysces pysces
2424
```
2525

26-
© Brett G. Olivier & Johann M. Rohwer, August 2021
26+
© Brett G. Olivier & Johann M. Rohwer, January 2024

0 commit comments

Comments
 (0)