Explore with notebooks
The walkthroughs below are rendered examples, so you can read them directly in your browser without installing anything. They demonstrate how to use VRS-Python to build variation models, compute identifiers, translate variant descriptions, and access sequence data. You can also download a notebook from its page and run it in Jupyter. Pages show saved outputs, which may differ from a fresh run against your installed release and configured data services.
| Notebook | What you will learn |
|---|---|
| Quick start | Translate a variant using sequence services |
| SeqRepo data proxy | Retrieve sequences and resolve aliases |
| Basic models | Build alleles and compute identifiers |
| Allele translator | Translate supported variant nomenclatures |
| CNV translator | Represent copy number variation |
| Upcoming features | Explore development examples, subject to change |
| Uncertain HGVS ranges | Work with uncertain coordinates |
Data access
Some notebooks use public demonstration endpoints for sequence and transcript data. These endpoints are intended for exploring the examples. For heavy workloads or production use, we recommend running your own local services. Follow SeqRepo and UTA to set them up, then update the notebooks to use your endpoints. Inspect setup cells before running them, since they may override environment variables you set in the shell.
Run the notebooks with MyBinder
Binder provides a ready-to-use computing environment for running the notebooks directly in your browser, with no local installation required.
You can launch the notebooks on Binder here.
Once launched, select VRS_kernel as the notebook kernel.
Run the notebooks locally
Clone the VRS-Python repository, then follow the
Installation steps to create the virtual environment (venv)
and activate it.
Notebook dependency
If you did not install the notebooks optional dependency during setup,
run this command from the root of the cloned project (vrs-python/),
with the virtual environment activated:
Open a notebook
We recommend either of the following options for opening a notebook.
JupyterLab
-
In the terminal, activate the project's
venvvirtual environment:source venv/bin/activate -
In the activated virtual environment, start JupyterLab:
python3 -m jupyterlab -
JupyterLab usually opens automatically in a new browser window. If it does not, open the URL shown in the terminal.
- Open a notebook from the
notebooks/directory.
VS Code
- Install the Python extension and Jupyter extension.
- Open the project root in VS Code and open a notebook from the
notebooks/directory. - Select Select Kernel in the upper-right corner and choose the Python
interpreter from the repository's
venvvirtual environment.