Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tcp-lab/mtp-db

The Membrane Transport Protein Database
https://github.com/tcp-lab/mtp-db

phd-project transcriptomics transportome

Last synced: 10 days ago
JSON representation

The Membrane Transport Protein Database

Host: GitHub
URL: https://github.com/tcp-lab/mtp-db
Owner: TCP-Lab
License: gpl-3.0
Created: 2022-09-22T13:08:52.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-11-04T10:04:41.000Z (14 days ago)
Last Synced: 2024-11-04T11:19:05.040Z (14 days ago)
Topics: phd-project, transcriptomics, transportome
Language: Python
Homepage:
Size: 293 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 12
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: COPYING
- Citation: CITATION.cff
- Roadmap: ROADMAP.md
- Authors: AUTHORS.md

Awesome Lists containing this project

README

        # MTP-DB - The Membrane Transport Protein Database

[![DOI](https://zenodo.org/badge/539987341.svg)](https://zenodo.org/badge/latestdoi/539987341)

[![Python](https://img.shields.io/badge/Python-v3.10-blue)](https://www.python.org/downloads/release/python-31011/)

[![Docker](https://img.shields.io/docker/pulls/cmalabscience/mtpdb)](https://hub.docker.com/r/cmalabscience/mtpdb)

[![All Contributors](https://img.shields.io/github/all-contributors/CMA-Lab/MTP-DB?style=flat)](#contributors-)

Welcome to the repository for the MTP-DB, a database that aims to collect information regarding the transportome, and the proteins that make it up.

The repository contains Daedalus, a Python package to download, parse and rebuild the MTP-DB on the fly. You can also find database releases in the [releases page](https://github.com/CMA-Lab/MTP-DB/releases) with pre-generated database files.

Daedalus takes care of connecting to, downloading from, parsing and patching data retrieved from remote databases, compiling them into the MTP-DB. Daedalus is written in Python.

You can take a look at the [CHANGELOG.md](CHANGELOG.md) file for a changelog of each release of the database.

To browse the database locally, we suggest SQLite browsers such as [this FOSS program](https://sqlitebrowser.org/).

The structure of the MTP-DB is detailed [in this excel file](https://docs.google.com/spreadsheets/d/16vb_2FvZdaUSVOc8m9yRPT6eYP8cGl4UsOzauI2Qbek/edit?usp=sharing). 

## Citing the MTP-DB

If you use the MTP-DB in your research, please cite:

> Luca Visentin, Federico Alessandro Ruffinatti, The MTP-DB, DOI: [10.5281/zenodo.7868055](https://doi.org/10.5281/zenodo.7868055)

More information is present in the [CITATION.cff](CITATION.cff) file.

## Generating the MTP-DB locally

You have two options if you wish to regenerate the MTP-DB locally.

You can download the pre-built Docker container from our DockerHub repository and execute that. You will need to install [Docker](https://www.docker.com/) to do this:

```bash

docker run -it --rm -v "OUT_DIR:/app/out" "cmalabscience/mtpdb:VERSION" "/app/out" --help

```

Just replace `OUT_DIR` with the full path to the output directory of your choice and `VERSION` with a valid version (see our [releases](https://github.com/CMA-Lab/MTP-DB/releases) and our [Docker Hub repository](https://hub.docker.com/r/cmalabscience/mtpdb)). Any arguments to Daedalus (e.g. `--help`) can be passed at the end of the command. You can find a script ([`./src/scripts/run_remote_docker`](https://github.com/CMA-Lab/MTP-DB/blob/main/src/scripts/run_remote_docker)) that does this in a more user-friendly way in the scripts folder.

If you do not wish to use Docker, you wish to use the latest code, or you want to modify the code locally, clone the repository to your local machine. You will need to have Python `3.10.10` and `git` installed:

```bash

git clone [email protected]:CMA-Lab/MTP-DB.git

cd MTP-DB/src

# It is optional, but highly reccomended to work in a

# Python virtual environment

python -m venv env

source env/bin/activate

pip install -r requirements.txt

```

You can then run Daedalus with:

```bash

python -m daedalus --help

```

As an alternative, you can take a look in the `src/scripts` folder for helper scripts that regenerate and run a locally-made Docker container. This way, you can work on local code but without having to have Python installed (but having Docker installed). For example:

```bash

git clone [email protected]:CMA-Lab/MTP-DB.git

cd MTP-DB/src

./scripts/rrun --help

```

Be aware that these scripts are working-directory sensible, and will only work if your current WD is in `MTP-DB/src/`.

# Contributing

We are very fond of contributors and collaborators. Please take a look at the [contributing guide](CONTRIBUTING.md) if you wish to contribute.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_{Federico Alessandro Ruffinatti}
🐛 💻 🚧

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## Licensing

Daedalus itself and all associated software in this repository is licensed following the [`COPYING`](COPYING) file. We are not sponsored or licensed by any of the data sources that we use.

The data downloaded and parsed by Daedalus is licensed under:

- The IUPHAR database: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) - Harding SD, Armstrong JF, Faccenda E, Southan C, Alexander SPH, Davenport AP, Pawson AJ, Spedding M, Davies JA; NC-IUPHAR. (2021) The IUPHAR/BPS guide to PHARMACOLOGY in 2022: curating pharmacology for COVID-19, malaria and antibacterials. Nucl. Acids Res. 2022. 50(D1) D1282-D1294. doi: 10.1093/nar/gkab1010. [Full text](https://academic.oup.com/nar/advance-article/doi/10.1093/nar/gkab1010/6414576). PMID: 34718737.

- The COSMIC database: [Custom License](https://cancer.sanger.ac.uk/license/COSMIC_Non_Commercial_Use_Terms_October2021.pdf). Data is remixed and parsed, so the content of the COSMIC database is not redistributed as-is (which would be forbidden).

- The Gene Onthology: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Current Zenodo DOI: https://dx.doi.org/10.5281/zenodo.7504797

- The TCDB: [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) - Latest publication: Saier MH, Reddy VS, Moreno-Hagelsieb G, Hendargo KJ, Zhang Y, Iddamsetty V, Lam KJK, Tian N, Russum S, Wang J, Medrano-Soto A. (2021). The Transporter Classification Database (TCDB): 2021 update. Nucleic Acids Res. 49(D1):D461-7 [33170213](https://pubmed.ncbi.nlm.nih.gov/33170213/)

- Ensembl places its data in the Public Domain ([more info](https://www.ensembl.org/info/about/legal/disclaimer.html)).

- The Human Gene Nomenclature Committee places its data in the Public Domain ([CC0](https://creativecommons.org/share-your-work/public-domain/cc0/), [more info](https://www.genenames.org/about/license/))

- The Human Protein Atlas: [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) - Uhlén M et al., Tissue-based map of the human proteome. Science (2015)

PubMed: 25613900 DOI: 10.1126/science.1260419 ([more info](https://www.proteinatlas.org/about/licence))

(Last updated on the 22nd of June, 2023)