Skip to content

Commit

Permalink
Update INSTALLation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
BoPeng committed Aug 31, 2024
1 parent a21935b commit b8db48c
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 1 deletion.
53 changes: 52 additions & 1 deletion INSTALL
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down

0 comments on commit b8db48c

Please sign in to comment.