[](https://biobb-template.readthedocs.io/en/latest/?badge=latest)
# biobb_netprop
## Introduction
BioBB formulated for the Disc4All EU project, containing functions for interrogating the DisGenet database, parsing the HIPPIE PPI database and using NetworkX to create basic nodes for a prioritized network based on the mentioned databases retrieval.
new Biobbs by the community.
Biobb (BioExcel building blocks) packages are Python building blocks that create new layer of compatibility and interoperability over popular bioinformatics tools.
The latest documentation of this package can be found in our readthedocs site:
[latest API documentation](http://biobb_netprop.readthedocs.io/en/latest/).
## Version
v1.0.0 2022.4
## Installation
If you have no experience with anaconda, please first take a look to the [New with anaconda?](https://biobb-documentation.readthedocs.io/en/latest/first_steps.html#new-with-anaconda) section of the [official documentation](https://biobb-documentation.readthedocs.io/en/latest/).
### Download repository
Although the biobb_netprop repository is available at GitHub and thus you can clone it, we strongly recommend you to **download it compressed** and start your new project from scratch.
### Create new conda environment
Once you have the project unzipped in your computer, please follow the next steps to create a new conda environment:
```console
cd biobb_netprop
conda env create -f conda_env/environment.yml
```
### Update environment paths
Edit **conda_env/biobb_netprop.pth** with the paths to your *biobb_netprop* folder. Example:
```console
/home/user_name/projects/biobb_netprop/
/home/user_name/projects/biobb_netprop/biobb_netprop/netptrop
```
Copy the edited **conda_env/biobb_netprop.pth** file to the site-packages folder of your environment. This folder is in */[anaconda-path]/envs/biobb_netprop/lib/python3.7/site-packages*, where */[anaconda-path]* is usually */anaconda3* or */opt/conda*.
```console
cp conda_env/biobb_netprop.pth /[anaconda-path]/envs/biobb_netprop/lib/python3.7/site-packages
```
### Activate environment
Then, activate the recently created *biobb_netprop* conda environment:
```console
conda activate biobb_netprop
```
### Create repository
This netprop includes some folders not standard for a biobb, such as **biobb_netprop/adapters/**, **biobb_netprop/notebooks/** or **conda_env/**. For the sake of having a pure biobb structure, you should uncomment the three last lines of the **.gitignore** file before creating a new git repository:
```console
biobb_netprop/adapters
biobb_netprop/notebooks
conda_env
```
Then, inialitize repository:
```console
git init
```
### WorkFlow example
In this directory, there is also a implemented Python version of the Static WorkFlow, but for it to run, it is **mandatory** to download and modify their paths in the YAML file, the DisGenet and the HIPPIE databases locally.
You can find them [here](https://github.com/mapoferri/datasets_netprop).
**Remember to unzip the files before using them, and remember also to modify the path of the directory/datasets in the YML file).**
### Binary paths configuration
Additionally, it's recommendable to configure binary paths in your environment in order to ease the command line execution. More info about this subject in the [Binary path configuration](https://biobb-documentation.readthedocs.io/en/latest/execution.html#binary-path-configuration) section of the [official documentation](https://biobb-documentation.readthedocs.io/en/latest/).
## Documentation
[Click here to find the API Documentation example](https://biobb-netprop.readthedocs.io/en/latest/netprop.html) for this BioBB and [here for Command Line documentation](http://biobb_netprop.readthedocs.io/en/latest/command_line.html).
And here you can find [the full documentation](https://biobb-documentation.readthedocs.io/en/latest/) about how to build a new **BioExcel building block** from scratch.
## Copyright & Licensing
This software has been developed in the [MMB group](http://mmb.irbbarcelona.org) at the [BSC](http://www.bsc.es/) & [IRB](https://www.irbbarcelona.org/) for the [European BioExcel](http://bioexcel.eu/), funded by the European Commission (EU H2020 [823830](http://cordis.europa.eu/projects/823830), EU H2020 [675728](http://cordis.europa.eu/projects/675728)), Disc4All [955735](http://cordis.europa.eu/projects/955735).
* (c) 2015-2020 [Barcelona Supercomputing Center](https://www.bsc.es/)
* (c) 2015-2020 [Institute for Research in Biomedicine](https://www.irbbarcelona.org/)
Licensed under the
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), see the file LICENSE for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/mapoferri/Biobb_NetProp",
"name": "biobb-netprop",
"maintainer": "",
"docs_url": null,
"requires_python": "==3.7.*",
"maintainer_email": "",
"keywords": "Bioinformatics Workflows BioExcel Compatibility",
"author": "Biobb developers - Maria Paola Ferri",
"author_email": "maria.ferri@bsc.es",
"download_url": "https://files.pythonhosted.org/packages/db/3b/f144ba8469d887321019e29ab66b114dd912560f22727151e774629b2836/biobb_netprop-1.12.3.tar.gz",
"platform": null,
"description": "[](https://biobb-template.readthedocs.io/en/latest/?badge=latest)\n\n# biobb_netprop\n\n## Introduction\nBioBB formulated for the Disc4All EU project, containing functions for interrogating the DisGenet database, parsing the HIPPIE PPI database and using NetworkX to create basic nodes for a prioritized network based on the mentioned databases retrieval.\nnew Biobbs by the community.\nBiobb (BioExcel building blocks) packages are Python building blocks that create new layer of compatibility and interoperability over popular bioinformatics tools.\nThe latest documentation of this package can be found in our readthedocs site:\n[latest API documentation](http://biobb_netprop.readthedocs.io/en/latest/).\n\n## Version\nv1.0.0 2022.4\n\n## Installation\n\nIf you have no experience with anaconda, please first take a look to the [New with anaconda?](https://biobb-documentation.readthedocs.io/en/latest/first_steps.html#new-with-anaconda) section of the [official documentation](https://biobb-documentation.readthedocs.io/en/latest/).\n\n### Download repository\n\nAlthough the biobb_netprop repository is available at GitHub and thus you can clone it, we strongly recommend you to **download it compressed** and start your new project from scratch. \n\n### Create new conda environment\n\nOnce you have the project unzipped in your computer, please follow the next steps to create a new conda environment:\n\n```console\ncd biobb_netprop\nconda env create -f conda_env/environment.yml\n```\n\n### Update environment paths\n\nEdit **conda_env/biobb_netprop.pth** with the paths to your *biobb_netprop* folder. Example:\n\n```console\n/home/user_name/projects/biobb_netprop/\n/home/user_name/projects/biobb_netprop/biobb_netprop/netptrop\n```\n\nCopy the edited **conda_env/biobb_netprop.pth** file to the site-packages folder of your environment. This folder is in */[anaconda-path]/envs/biobb_netprop/lib/python3.7/site-packages*, where */[anaconda-path]* is usually */anaconda3* or */opt/conda*.\n\n```console\ncp conda_env/biobb_netprop.pth /[anaconda-path]/envs/biobb_netprop/lib/python3.7/site-packages\n```\n\n### Activate environment\n\nThen, activate the recently created *biobb_netprop* conda environment:\n\n```console\nconda activate biobb_netprop\n```\n\n### Create repository\n\nThis netprop includes some folders not standard for a biobb, such as **biobb_netprop/adapters/**, **biobb_netprop/notebooks/** or **conda_env/**. For the sake of having a pure biobb structure, you should uncomment the three last lines of the **.gitignore** file before creating a new git repository:\n\n```console\nbiobb_netprop/adapters\nbiobb_netprop/notebooks\nconda_env\n```\nThen, inialitize repository:\n\n```console\ngit init\n```\n\n\n### WorkFlow example\n\nIn this directory, there is also a implemented Python version of the Static WorkFlow, but for it to run, it is **mandatory** to download and modify their paths in the YAML file, the DisGenet and the HIPPIE databases locally. \nYou can find them [here](https://github.com/mapoferri/datasets_netprop).\n**Remember to unzip the files before using them, and remember also to modify the path of the directory/datasets in the YML file).**\n\n### Binary paths configuration\n\nAdditionally, it's recommendable to configure binary paths in your environment in order to ease the command line execution. More info about this subject in the [Binary path configuration](https://biobb-documentation.readthedocs.io/en/latest/execution.html#binary-path-configuration) section of the [official documentation](https://biobb-documentation.readthedocs.io/en/latest/).\n\n## Documentation\n\n[Click here to find the API Documentation example](https://biobb-netprop.readthedocs.io/en/latest/netprop.html) for this BioBB and [here for Command Line documentation](http://biobb_netprop.readthedocs.io/en/latest/command_line.html).\n\nAnd here you can find [the full documentation](https://biobb-documentation.readthedocs.io/en/latest/) about how to build a new **BioExcel building block** from scratch.\n\n## Copyright & Licensing\nThis software has been developed in the [MMB group](http://mmb.irbbarcelona.org) at the [BSC](http://www.bsc.es/) & [IRB](https://www.irbbarcelona.org/) for the [European BioExcel](http://bioexcel.eu/), funded by the European Commission (EU H2020 [823830](http://cordis.europa.eu/projects/823830), EU H2020 [675728](http://cordis.europa.eu/projects/675728)), Disc4All [955735](http://cordis.europa.eu/projects/955735).\n\n* (c) 2015-2020 [Barcelona Supercomputing Center](https://www.bsc.es/)\n* (c) 2015-2020 [Institute for Research in Biomedicine](https://www.irbbarcelona.org/)\n\nLicensed under the\n[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), see the file LICENSE for details.\n\n![alt-text-1](https://bioexcel.eu/wp-content/uploads/2019/04/Bioexcell_logo_1080px_transp.png \"Bioexcel\") \n",
"bugtrack_url": null,
"license": "",
"summary": "Biobb_NetProp is use case to build a prioritize PPI Network through Disc4All pre-process database REST API.",
"version": "1.12.3",
"split_keywords": [
"bioinformatics",
"workflows",
"bioexcel",
"compatibility"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "db3bf144ba8469d887321019e29ab66b114dd912560f22727151e774629b2836",
"md5": "4bb92cb624d433e78a2ec539239cbb73",
"sha256": "631d6464449bbd7e10a848306e0c95ddc1ae5bcd5e51da63a69de9670bcfe856"
},
"downloads": -1,
"filename": "biobb_netprop-1.12.3.tar.gz",
"has_sig": false,
"md5_digest": "4bb92cb624d433e78a2ec539239cbb73",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "==3.7.*",
"size": 30671,
"upload_time": "2023-04-06T15:26:58",
"upload_time_iso_8601": "2023-04-06T15:26:58.575181Z",
"url": "https://files.pythonhosted.org/packages/db/3b/f144ba8469d887321019e29ab66b114dd912560f22727151e774629b2836/biobb_netprop-1.12.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-06 15:26:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mapoferri",
"github_project": "Biobb_NetProp",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "biobb-netprop"
}
JSON
