Skip to content

Commit

Permalink
Update README.md: recommend partial clone to save 15GB
Browse files Browse the repository at this point in the history
  • Loading branch information
corneliusroemer committed May 18, 2023
1 parent f8d2d95 commit fe4cc44
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Full details on how to suggest a new lineage can be found in the [Pango lineage

Nomenclature rules can be found in the [Pango statement of nomenclature rules](https://www.pango.network/the-pango-nomenclature-system/statement-of-nomenclature-rules/).


## Resources available on this repository

As detailed on the pango.network website, we host the lineage description list (LDL) and sequence designation list (SDL) in this repository.
Expand All @@ -19,3 +18,14 @@ As detailed on the pango.network website, we host the lineage description list (

### Other
The lineage_constellations directory contains the mutations associated with each of the AY lineages. These are the mutations that were acquried along the phylogenetic path leading to the common ancestor of the lineage and remain conserved in the lineage (defined here as being in >70% of sequences designated to the lineage). This path is identified using the UShER phylogenetic tree. These constellations are different from those in [constellations](https://github.com/cov-lineages/constellations) as they attempt to capture all of the associated mutations, not only the defining mutations for a lineage. These constellations are provided for reference and are not used by scorpio currently. However, they should be compatible with scorpio if researchers are interested in exploring them. Sites in the intermediate category drop in and out in the Delta clade so may be associated with the lineage but may be prone to artefacts.

## Developer docs

It is recommended to clone this repo using `--filter=blob:none` for a blobless clone unless you want to download and put 15GB on your hard drive. The `lineages.csv` file is quite large and since git stores the state of each file at each commit, that creates a large repo. Git is good at downloading past blobs when necessary, so you shouldn't be impacted in your day to day work by doing this partial clone. Learn more about partial clone here: https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/

Recommended commands to clone:

```bash
git clone git clone --filter=blob:none git+https://github.com/cov-lineages/pango-designation.git
gh repo clone cov-lineages/pango-designation -- --filter=blob:none
```

1 comment on commit fe4cc44

@lanshitouj
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

xbb.1

Please sign in to comment.