Merge pull request #115 from monarch-initiative/issue-114

Adding installation guide.
monarch-initiative · May 21, 2024 · 21dc084 · 21dc084
2 parents ff83434 + 42c5846
commit 21dc084
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 66 deletions.
diff --git a/.github/workflows/generate_phenopackets.yml b/.github/workflows/generate_phenopackets.yml
diff --git a/docs/developers/developers.md b/docs/developers/developers.md
@@ -1,5 +1,35 @@
 # For developers
 
+## Local Installation
+
+We recommend creating a local environment:
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+```
+
+and updating Python's `pip` tool:
+
+```bash
+python3 -m pip install --upgrade pip
+```
+
+You can then do a local/editable install:
+
+
+```bash
+python3 -m pip install --editable ".[test]"
+```
+
+After installation you should be able to run the test suite:
+
+```bash
+pytest
+```
+
+
+## Creating Phenopackets
 
 pyphetools provides two main ways of creating phenopackets.
 

diff --git a/docs/user-guide/template.md b/docs/user-guide/template.md
@@ -64,7 +64,7 @@ tc.create_template(disease_id="",
                          disease_label="",
                          gene_symbol="",
                          HGNC_id="",
-                         transcript=""
+                         transcript="")
 ```