search

blab / pathogen-embed

Create reduced dimension embeddings for pathogen sequences
https://pypi.org/project/pathogen-embed/
MIT License
1 stars 0 forks source link

Add quickstart guide #16

Closed huddlej closed 4 months ago

huddlej commented 5 months ago

Adds a quickstart guide to the README, allowing users to quickly test the pathogen-embed tools with data in the repository and also demonstrate in the README the nature of the outputs from each command.

Preview the new guide in this branch's README.

nandsra21 commented 5 months ago

@huddlej This looks great! Do you want me to add anything to the guide, or should I approve the request since I've taken a look at and like the quickstart guide?

huddlej commented 5 months ago

@nandsra21 Can you try running through all of the commands in the quickstart with a fresh installation of the tool, just to make sure everything works for you, too?

huddlej commented 4 months ago

I'm going to merge this, so we can start referring to it elsewhere.