From b8db48c2825b5a67d2a3aba3f2a527cec5dc72c1 Mon Sep 17 00:00:00 2001 From: Bo Peng Date: Fri, 30 Aug 2024 22:41:59 -0500 Subject: [PATCH] Update INSTALLation instructions --- INSTALL | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++- README.md | 6 ++++++ 2 files changed, 58 insertions(+), 1 deletion(-) diff --git a/INSTALL b/INSTALL index 4ab868b8..bb2a59b5 100644 --- a/INSTALL +++ b/INSTALL @@ -1 +1,52 @@ -Please refer to https://github.com/BoPeng/simuPOP/Main/Download for detailed instructions. +## Installation of simuPOP + +NOTE: The following instructions can be out of date due to the evolution of operating systens, Python, and +the Python tool chain. Please [submit an issue](https://github.com/BoPeng/simuPOP/issues) if you fail to +install simuPOP with the provided instructions, and/or submit a PR to update these instructions. + +### Install using conda + +If you have Anaconda installed, you can install simuPOP with command + +``` +conda install -c conda-forge simuPOP +``` + +### Compile from source + +If you are working with a development version of simuPOP or an unsupported platform, you may need to install simuPOP from source. +Generally speaking, you will need a C/C++ compiler and zlib. + +#### Checkout the simuPOP source code + +Using any git client, checkout simuPOP from https://github.com/BoPeng/simuPOP. + +#### Linux + +Linux systems generally have gcc installed. To compile simuPOP from source, just run + +``` +python setup.py install +``` + + +#### Windows + +You will need a C++ compiler from Visual Studio. A community version can be downloaded from Microsoft free of charge. +After you have install MSVC, run + +``` +conda install -c conda-forge vs2022_win-64 +``` +to make VC available to conda, and + +``` +conda install -c conda-forge zlib +``` +to install zlib. + + +You can then compile simuPOP with command +``` +python setup.py install +``` diff --git a/README.md b/README.md index ba038044..d07a8b84 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,9 @@ simuPOP is part of the [conda-forge](https://conda-forge.github.io/), if you use conda install -c conda-forge simuPOP ``` +If you are working with a development version of simuPOP or an unsupported platform, you may need to install simuPOP from source. Please +refer to [INSTALLATION](https://github.com/BoPeng/simuPOP/blob/master/INSTALL) for details. + If you would like to use simuPOP with Python 2.5 - 2.7, please compile simuPOP from source, using either [simuPOP 1.1.7](https://pypi.python.org/pypi/simuPOP/1.1.7), or the [Python 2.x branch of simuPOP](https://github.com/BoPeng/simuPOP/tree/python2). Note that features that has been marked deprecated (e.g. `simuOpt.Param`, `simuPOP.plotting`) in simuPOP 1.1.7 and earlier are removed in simuPOP 1.1.8+, so simuPOP 1.1.7 would be your best @@ -25,6 +28,9 @@ The user guide and reference manual of simuPOP is available at http://bopeng.git ## Change Log since 1.1.7 +### simuPOP 1.1.15 +* [#122](https://github.com/BoPeng/simuPOP/issues/122) Fix compatibility with Visual Studio 2022 under windows. + ### simuPOP 1.1.14 * [#114](https://github.com/BoPeng/simuPOP/issues/117) Fix compatibility with Python 3.11.