|
2 | 2 |
|
3 | 3 | <h1>xerxes CLI software</h1> |
4 | 4 |
|
5 | | -`xerxes` is a command line software tool for population genetic analyses of Poseidon packages. It is written in Haskell and openly available on [GitHub](https://github.com/poseidon-framework/poseidon-analysis-hs/). |
| 5 | +`xerxes` is a command line software tool for population genetic analyses of Poseidon packages. It is written in Haskell and openly available on [GitHub](https://github.com/poseidon-framework/poseidon-hs/). |
6 | 6 |
|
7 | | -[](https://github.com/poseidon-framework/poseidon-analysis-hs/actions/workflows/main.yml) |
8 | | -[](https://codecov.io/github/poseidon-framework/poseidon-analysis-hs?branch=main) |
9 | | -[ ](https://github.com/poseidon-framework/poseidon-analysis-hs/releases) |
10 | | -[](https://anaconda.org/bioconda/poseidon-xerxes) |
11 | | -[](https://anaconda.org/bioconda/poseidon-xerxes) |
| 7 | +!> Before April 2026 xerxes was developed in a repository [here](https://github.com/poseidon-framework/poseidon-analysis-hs), so legacy releases can be found there. |
| 8 | + |
| 9 | +[](https://github.com/poseidon-framework/poseidon-hs/actions/workflows/main.yml) |
| 10 | +[](https://codecov.io/github/poseidon-framework/poseidon-hs?branch=master) |
| 11 | +[ ](https://github.com/poseidon-framework/poseidon-hs/releases) |
| 12 | +[](https://anaconda.org/bioconda/poseidon-xerxes) [](https://anaconda.org/bioconda/poseidon-xerxes) |
12 | 13 |
|
13 | 14 | To download the latest stable release version of `xerxes` click here: |
14 | | -[📥 Linux](https://github.com/poseidon-framework/poseidon-analysis-hs/releases/latest/download/xerxes-Linux) | |
15 | | -[📥 macOS (ARM64)](https://github.com/poseidon-framework/poseidon-analysis-hs/releases/latest/download/xerxes-macOS-ARM64) | |
16 | | -[📥 macOS (X64)](https://github.com/poseidon-framework/poseidon-analysis-hs/releases/latest/download/xerxes-macOS-X64) | |
17 | | -[📥 Windows](https://github.com/poseidon-framework/poseidon-analysis-hs/releases/latest/download/xerxes-Windows.exe) |
| 15 | +[📥 Linux](https://github.com/poseidon-framework/poseidon-hs/releases/latest/download/xerxes-Linux) | |
| 16 | +[📥 macOS (ARM64)](https://github.com/poseidon-framework/poseidon-hs/releases/latest/download/xerxes-macOS-ARM64) | |
| 17 | +[📥 macOS (X64)](https://github.com/poseidon-framework/poseidon-hs/releases/latest/download/xerxes-macOS-X64) | |
| 18 | +[📥 Windows](https://github.com/poseidon-framework/poseidon-hs/releases/latest/download/xerxes-Windows.exe) |
18 | 19 |
|
19 | 20 | So in Linux you can run the following commands to get started: |
20 | 21 |
|
21 | 22 | ```bash |
22 | 23 | # download the current stable release binary |
23 | | -wget https://github.com/poseidon-framework/poseidon-analysis-hs/releases/latest/download/xerxes-Linux |
| 24 | +wget https://github.com/poseidon-framework/poseidon-hs/releases/latest/download/xerxes-Linux |
24 | 25 | # make it executable |
25 | 26 | chmod +x xerxes-Linux |
26 | 27 | # run it |
27 | 28 | ./xerxes-Linux -h |
28 | 29 | ``` |
29 | 30 |
|
30 | | -On GitHub you will also find [older release versions](https://github.com/poseidon-framework/poseidon-analysis-hs/releases) and [instructions to build xerxes from source](https://github.com/poseidon-framework/poseidon-analysis-hs#for-haskell-developers). The relevant changes from one version to the next are documented in this [changelog](https://github.com/poseidon-framework/poseidon-analysis-hs/blob/main/CHANGELOGRELEASE.md). |
| 31 | +On GitHub you will also find [older release versions](https://github.com/poseidon-framework/poseidon-hs/releases) and [instructions to build xerxes from source](https://github.com/poseidon-framework/poseidon-hs#for-haskell-developers). The relevant changes from one version to the next are documented in this [changelog](https://github.com/poseidon-framework/poseidon-hs/blob/master/CHANGELOGRELEASE.md). |
31 | 32 |
|
32 | 33 | With `xerxes --help` and `xerxes <subcommand> --help` you can get information about each subcommand and parameter directly on the command line. The guide below explains the subcommands in more detail. It is available in .pdf format for the current and previous versions here: |
33 | 34 |
|
34 | 35 | - [🗎 Guide for xerxes v1.0.1.0 or higher](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/xerxes.pdf) (shown below) |
35 | 36 | - [🗎 Guide for xerxes v1.0.0.2](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/xerxes_guide_archive/xerxes_guide_1.0.0.2.pdf) |
36 | 37 | - [🗎 Guide for xerxes v0.2.0.0](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/xerxes_guide_archive/xerxes_guide_0.2.0.0.pdf) |
37 | 38 |
|
38 | | -# Guide for xerxes v1.0.1.0 to v1.0.1.1 |
| 39 | +# Guide for xerxes v1.0.1.0 to v2.0.0.0 |
39 | 40 |
|
40 | 41 | ## Installation |
41 | 42 |
|
42 | | -See the Poseidon website (<https://www.poseidon-adna.org/#/xerxes>) or the GitHub repository (<https://github.com/poseidon-framework/poseidon-analysis-hs>) for up-to-date installation instructions. |
| 43 | +See the Poseidon website (<https://www.poseidon-adna.org/#/xerxes>) or the GitHub repository (<https://github.com/poseidon-framework/poseidon-hs>) for up-to-date installation instructions. |
43 | 44 |
|
44 | 45 | ## Fstats command |
45 | 46 |
|
@@ -269,7 +270,7 @@ These cases are detected and an error is thrown. For `F2`, `F3` and `FST` you ca |
269 | 270 |
|
270 | 271 | ### Whitepaper |
271 | 272 |
|
272 | | -The repository comes with a [detailed whitepaper](https://github.com/poseidon-framework/poseidon-analysis-hs/blob/main/docs/xerxes_whitepaper.pdf) that describes some more mathematical details of the methods implemented here. |
| 273 | +The repository comes with a [detailed whitepaper](https://github.com/poseidon-framework/poseidon-hs/blob/master/xerxes_whitepaper/Xerxes_whitepaper.pdf) that describes some more mathematical details of the methods implemented here. |
273 | 274 |
|
274 | 275 | ## RAS command (in development) |
275 | 276 |
|
|
0 commit comments