Skip to content

Commit b39bec3

Browse files
Merge pull request #567 from benjeffery/README-tweaks
README tweaks
2 parents eaf8c5f + 15ca30b commit b39bec3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ python -m pip install sc2ts[inference]
3636
The sc2ts API provides two convenience functions to compute summary
3737
dataframes for the nodes and mutations in a sc2ts-output ARG.
3838

39-
To see some examples, first download the sc2ts inferred ARG
39+
To see some examples, first download the (31MB) sc2ts inferred ARG
4040
from [Zenodo](https://zenodo.org/records/17558489/):
4141

4242
```
@@ -109,7 +109,7 @@ python -m pip install sc2ts[inference]
109109
**This is essential! The base install of sc2ts contains the minimal
110110
dependencies required to access the analysis utilities outlined above.**
111111

112-
Then, download the Viridian dataset in
112+
Then, download the (401MB) Viridian dataset in
113113
[VCF Zarr format](https://doi.org/10.1093/gigascience/giaf049) from
114114
[Zenodo](https://zenodo.org/records/16314739):
115115

@@ -137,7 +137,7 @@ for little while to see how things work:
137137
python3 -m sc2ts infer example_config.toml --stop=2020-02-02
138138
```
139139

140-
Once this finishes (it should take a few minutes), the results of the
140+
Once this finishes (it should take a few minutes and requires ~5GB RAM), the results of the
141141
inference will be in the ``example_inference`` directory (as specified in the
142142
config file) and look something like this:
143143

@@ -270,7 +270,7 @@ The tree sequences files output during primary inference have a lot
270270
of debugging metadata, and there are some developer tools for inspecting
271271
this in the ``sc2ts.debug`` package. In particular, the ``ArgInfo``
272272
class has a lot of useful utilities designed to be used in a Jupyter
273-
notebook. Use it like
273+
notebook. Note that ``matplotlib`` is required for these. Use it like:
274274

275275
```python
276276
import sc2ts.debug as sd

0 commit comments

Comments
 (0)