Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding installation guide. #115

Merged
merged 7 commits into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 0 additions & 65 deletions .github/workflows/generate_phenopackets.yml

This file was deleted.

30 changes: 30 additions & 0 deletions docs/developers/developers.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ tc.create_template(disease_id="",
disease_label="",
gene_symbol="",
HGNC_id="",
transcript=""
transcript="")
```


Expand Down