Provide computable object representation and validation for gene fusions
Project description
FUSOR
FUSOR (FUSion Object Representation) provides modeling and validation tools for representing gene fusions in a flexible, computable structure.
Installation
To install FUSOR:
pip install fusor
For a development install, we recommend using Pipenv. See the pipenv docs for direction on installing pipenv in your compute environment.
Once installed, from the project root dir, just run:
pipenv shell
pipenv lock && pipenv sync
MacOS Errors
If you encounter errors, try the following:
export SYSTEM_VERSION_COMPAT=1
pipenv lock && pipenv sync
Data Downloads
SeqRepo
FUSOR relies on seqrepo, which you must download yourself.
From the root directory:
pip install seqrepo
sudo mkdir /usr/local/share/seqrepo
sudo chown $USER /usr/local/share/seqrepo
seqrepo pull -i 2021-01-29 # Replace with latest version using `seqrepo list-remote-instances` if outdated
If you get an error similar to the one below:
PermissionError: [Error 13] Permission denied: '/usr/local/share/seqrepo/2021-01-29._fkuefgd' -> '/usr/local/share/seqrepo/2021-01-29'
You will want to do the following:
(Might not be ._fkuefgd, so replace with your error message path)
sudo mv /usr/local/share/seqrepo/2021-01-29._fkuefgd /usr/local/share/seqrepo/2021-01-29
exit
UTA
FUSOR also uses Common Operations On Lots-of Sequences Tool (cool-seq-tool) which uses UTA as the underlying PostgreSQL database.
The following commands will likely need modification appropriate for the installation environment.
-
Install PostgreSQL
-
Create user and database.
$ createuser -U postgres uta_admin $ createuser -U postgres anonymous $ createdb -U postgres -O uta_admin uta -
To install locally (location does not matter):
export UTA_VERSION=uta_20210129.pgd.gz
curl -O http://dl.biocommons.org/uta/$UTA_VERSION
gzip -cdq ${UTA_VERSION} | grep -v "^REFRESH MATERIALIZED VIEW" | psql -h localhost -U uta_admin --echo-errors --single-transaction -v ON_ERROR_STOP=1 -d uta -p 5433
UTA Installation Issues
If you have trouble installing UTA, you can visit these two READMEs.
Connecting to the UTA database
To connect to the UTA database, you can use the default url (postgresql://uta_admin@localhost:5433/uta/uta_20210129). If you use the default url, you must either set the password using environment variable UTA_PASSWORD or setting the parameter db_pwd in the FUSOR class.
If you do not wish to use the default, you must set the environment variable UTA_DB_URL which has the format of driver://user:pass@host:port/database/schema.
Gene Normalizer
FUSOR also relies on data from gene-normalizer's DynamoDB tables, which you must download yourself. See the README for deploying the database.
Init coding style tests
Code style is managed by Ruff and Black and checked prior to commit.
We use pre-commit to run conformance tests.
This performs checks for:
- Code style
- File endings
- Added large files
- AWS credentials
- Private keys
Before first commit run:
pre-commit install
Running unit tests
Running unit tests is as easy as pytest.
pipenv run pytest
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fusor-0.0.28.dev1.tar.gz.
File metadata
- Download URL: fusor-0.0.28.dev1.tar.gz
- Upload date:
- Size: 25.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e854766829492342e2a311a148dc38617e2ebf74d5fc2f3cae87b10b23f799a7 |
|
| MD5 | 243222ecd3f18f06b614d4e4970fabc4 |
|
| BLAKE2b-256 | 7e371f6799bb1b7a08324ce145f3dc70c44fbef493c1cc056d33314fd00be2cc |
File details
Details for the file fusor-0.0.28.dev1-py3-none-any.whl.
File metadata
- Download URL: fusor-0.0.28.dev1-py3-none-any.whl
- Upload date:
- Size: 27.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 778ee2117553e9b40c0ff9972239fceef3e4ea0b02205cd3e9ab956238a1e0a3 |
|
| MD5 | 0460875bfb54963b6c2b2a6552fd5449 |
|
| BLAKE2b-256 | a5a5291b1401a01c76e45133ca15d36e5274ee40d1e4dabfa4ef5371b3f175a5 |
