Badges
| fair-software.eu recommendations | |
|---|---|
| (1/5) code repository | |
| (2/5) license | |
| (3/5) community registry | |
| (4/5) citation | |
| (5/5) checklist | |
| overall | |
| Other best practices | |
| Documentation | |
| Build & Test | |
| Static analysis | |
| Coverage | |
| Citation data consistency |
NPLinker is a python framework for data mining microbial natural products by integrating genomics and metabolomics data.
Original paper: Ranking microbial metabolomic and genomic links in the NPLinker framework using complementary scoring functions.
Setup and usage
Requirement
- Linux, MacOS or Windows with WSL
- Python version ≥3.11
Installation
NPLinker is a python package, using both pypi packages and non-pypi packages as dependencies. It requires ~4.5GB of disk space to install all the dependencies.
# Create a new virtual environment and activate it
conda create -n npl-3.11 python=3.11
conda activate npl-3.11
# install from nplinker releases (requiring ~300MB of disk space)
pip install nplinker
# install nplinker non-pypi dependencies and databases (~4GB)
install-nplinker-deps
Testing
To run the tests, you need to clone this repo and install the development dependencies:
# Create a new virtual environment
conda create -n npl-3.11 python=3.11
conda activate npl-3.11
# Clone the repository and install the development dependencies
git clone https://github.com/NPLinker/nplinker.git
cd nplinker
pip install -e ".[dev]"
install-nplinker-deps
Unit tests
To run the unit tests, you can use the following command:
pytest
Pytest will use all available CPU cores to run the unit tests in parallel.
Integration tests
To run the integration tests, you can use the following command:
pytest -n1 tests/integration
The -n1 is to use one CPU core to run the tests. Change it to -n2 if you want to use two CPU cores to run in parallel.
Usage
See the documentation for more information about how to use NPLinker.
Contributing
If you want to contribute to the development of nplinker, have a look at the contribution guidelines and README for developers.
Metadata
Release files for nplinker 2.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nplinker-2.0.3.tar.gz | 77.8 kB | Without provenance | Details for nplinker-2.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nplinker-2.0.3-py3-none-any.whl | Python 3 | none | any | Details for nplinker-2.0.3-py3-none-any.whl |
Total release size: 174.8 kB
Release files / nplinker-2.0.3.tar.gz
| Download URL | nplinker-2.0.3.tar.gz |
|---|---|
| Size | 77.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d9af6a620d7dcc34109275eb140a1a631df4a33178b8be2c06675dcc4e252cfc
|
|
BLAKE2b-256 checksum How to use checksums |
791d178467ca8f3138a0d6080b310899b95ccaf1ad5f8c27597a6730d32090f0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
Release files / nplinker-2.0.3-py3-none-any.whl
| Download URL | nplinker-2.0.3-py3-none-any.whl |
|---|---|
| Size | 97.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
90ab6f49da0e6c81f063c4e0fc47721fa95ae427b2caacb9132778d0bbdaf2ef
|
|
BLAKE2b-256 checksum How to use checksums |
31cd057c351ba7c9352c14ebb7324bf1297dbe44fb64d7ec6f164ac7acd156c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
Security for nplinker 2.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.