Skip to content

Update readme for consistency across tskit-dev #398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 29, 2025
Merged

Update readme for consistency across tskit-dev #398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# pyslim

[![License](https://img.shields.io/github/license/tskit-dev/pyslim)](https://github.com/tskit-dev/pyslim/blob/main/LICENSE) [![PyPI version](https://img.shields.io/pypi/v/pyslim.svg)](https://pypi.org/project/pyslim/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/pyslim.svg)](https://pypi.org/project/pyslim/) [![Docs Build](https://github.com/tskit-dev/pyslim/actions/workflows/docs.yml/badge.svg)](https://github.com/tskit-dev/pyslim/actions/workflows/docs.yml) [![Tests](https://github.com/tskit-dev/pyslim/actions/workflows/tests.yml/badge.svg)](https://github.com/tskit-dev/pyslim/actions/workflows/tests.yml) [![codecov](https://codecov.io/gh/tskit-dev/pyslim/branch/main/graph/badge.svg)](https://codecov.io/gh/tskit-dev/pyslim)

`pyslim` is a python module that provides a few extra tools for dealing with tree sequences
produced by SLiM and for preparing other tree seuqences for use with SLiM.
produced by SLiM and for preparing other tree sequences for use with SLiM.
Most tree sequence functionality is provided by [tskit](https://tskit.dev/tskit).
Please see [our documentation](https://tskit.dev/pyslim/docs/stable/) for more information.
(That link is to documentation for the last release release;
Please see [our documentation](https://tskit.dev/pyslim/docs/stable/) ([latest](https://tskit.dev/pyslim/docs/latest/)) for more information.
(That link is to documentation for the last release;
instead, [the latest](https://tskit.dev/pyslim/docs/latest) documentation
may have additional examples, but may also describe features you need to install from github to get.)

Expand All @@ -14,4 +16,14 @@ To install `pyslim`, do
```
pip install pyslim
```
or read the documentation for how to [install from source](https://tskit.dev/pyslim/stable/development.html#sec-development).
or read the documentation for how to [install from source](https://tskit.dev/pyslim/docs/stable/development.html#sec-development).

Alternatively, install from conda-forge:

```
conda install -c conda-forge pyslim
```

## Quickstart

See tutorials and examples at https://tskit.dev/pyslim/docs/stable/
Loading