Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
kimrutherford committed Feb 7, 2024
1 parent 1c88240 commit 9668d66
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,25 @@
Run with:
# [PomBase](/pombase) code for processing domains

This program processes the `match_complete.xml.gz` from InterPro
and also runs [TMHMM](https://services.healthtech.dtu.dk/services/TMHMM-2.0/)
to generate a JSON of domain information.

The latest InterPro file is available from: https://ftp.ebi.ac.uk/pub/databases/interpro/current_release/

UniProt IDs for pombe proteins are queried from PostgreSQL. Those IDs are
used to filter the InterPro file.

/var/pomcur/bin/pombase-interpro -p "postgres://<username>:<password>@localhost/<dbname>" \
-i <(gzip -d < match_complete.xml.gz) -o pombe_interpro_results.json
Protein sequences are queried from PostgreSQL and are passed to TMHMM.
We run TMHMM in a separate thread while the InterPro XML is parsed and
processed.

## Running

Run with:

in: /var/pomcur/sources/interpro/
PATH=$PATH_TO_TMHMM_EXE:$PATH /var/pomcur/bin/pombase-interpro \
-p "postgres://<username>:<password>@localhost/<dbname>" \
-i <(gzip -d < match_complete.xml.gz) -o pombe_domain_results.json


## Status
Expand Down

0 comments on commit 9668d66

Please sign in to comment.