Skip to content

Commit 7258129

Browse files
committed
update of xerxes and trident documentation after v2.0.0.0 release
1 parent a2f2025 commit 7258129

2 files changed

Lines changed: 18 additions & 17 deletions

File tree

trident.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ On GitHub you will also find [older release versions](https://github.com/poseido
3030

3131
With `trident --help` and `trident <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:
3232

33-
- [🗎 Guide for trident v1.7.0.0](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/trident.pdf) (shown below)
33+
- [🗎 Guide for trident v1.7.0.0 or higher](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/trident.pdf) (shown below)
3434
- [🗎 Guide for trident v1.6.7.1 to v1.6.7.3](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/trident_guide_archive/trident_guide_1.6.7.1_to_1.6.7.3.pdf)
3535
- [🗎 Guide for trident v1.6.2.1](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/trident_guide_archive/trident_guide_1.6.2.1.pdf)
3636
- [🗎 Guide for trident v1.5.7.0 to v1.5.7.3](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/trident_guide_archive/trident_guide_1.5.7.0_to_1.5.7.3.pdf)
@@ -48,7 +48,7 @@ With `trident --help` and `trident <subcommand> --help` you can get information
4848
- [🗎 Guide for trident v0.29.0](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/trident_guide_archive/trident_guide_0.29.0.pdf)
4949
- [🗎 Guide for trident v0.28.0](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/trident_guide_archive/trident_guide_0.28.0.pdf)
5050

51-
# Guide for trident v1.7.0.0
51+
# Guide for trident v1.7.0.0 to v2.0.0.0
5252

5353
## Installation
5454

xerxes.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,45 @@
22

33
<h1>xerxes CLI software</h1>
44

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/).
66

7-
[![CI](https://github.com/poseidon-framework/poseidon-analysis-hs/actions/workflows/main.yml/badge.svg)](https://github.com/poseidon-framework/poseidon-analysis-hs/actions/workflows/main.yml)
8-
[![Coverage Status](https://img.shields.io/codecov/c/github/poseidon-framework/poseidon-analysis-hs/main.svg)](https://codecov.io/github/poseidon-framework/poseidon-analysis-hs?branch=main)
9-
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/poseidon-framework/poseidon-analysis-hs?include_prereleases) ![GitHub all releases](https://img.shields.io/github/downloads/poseidon-framework/poseidon-analysis-hs/total)](https://github.com/poseidon-framework/poseidon-analysis-hs/releases)
10-
[![Install with Bioconda](https://anaconda.org/bioconda/poseidon-xerxes/badges/version.svg)](https://anaconda.org/bioconda/poseidon-xerxes)
11-
[![Anaconda-Server Badge](https://anaconda.org/bioconda/poseidon-xerxes/badges/downloads.svg)](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+
[![CI](https://github.com/poseidon-framework/poseidon-hs/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/poseidon-framework/poseidon-hs/actions/workflows/main.yml)
10+
[![Coverage Status](https://img.shields.io/codecov/c/github/poseidon-framework/poseidon-hs/master.svg)](https://codecov.io/github/poseidon-framework/poseidon-hs?branch=master)
11+
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/poseidon-framework/poseidon-hs?include_prereleases) ![GitHub all releases](https://img.shields.io/github/downloads/poseidon-framework/poseidon-hs/total)](https://github.com/poseidon-framework/poseidon-hs/releases)
12+
[![Install with Bioconda](https://anaconda.org/bioconda/poseidon-xerxes/badges/version.svg)](https://anaconda.org/bioconda/poseidon-xerxes) [![Anaconda-Server Badge](https://anaconda.org/bioconda/poseidon-xerxes/badges/downloads.svg)](https://anaconda.org/bioconda/poseidon-xerxes)
1213

1314
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)
1819

1920
So in Linux you can run the following commands to get started:
2021

2122
```bash
2223
# 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
2425
# make it executable
2526
chmod +x xerxes-Linux
2627
# run it
2728
./xerxes-Linux -h
2829
```
2930

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).
3132

3233
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:
3334

3435
- [🗎 Guide for xerxes v1.0.1.0 or higher](https://github.com/poseidon-framework/poseidon-framework.github.io/blob/master/xerxes.pdf) (shown below)
3536
- [🗎 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)
3637
- [🗎 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)
3738

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
3940

4041
## Installation
4142

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.
4344

4445
## Fstats command
4546

@@ -269,7 +270,7 @@ These cases are detected and an error is thrown. For `F2`, `F3` and `FST` you ca
269270

270271
### Whitepaper
271272

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.
273274

274275
## RAS command (in development)
275276

0 commit comments

Comments
 (0)