| fair-software.eu recommendations | |
|---|---|
| (1/5) code repository |  |
| (2/5) license |  |
| (3/5) community registry |   |
| (4/5) citation |  |
| (5/5) checklist |  |
| how FAIR is |  |
| Other best practices | |
| Documentation |  🔗 |
| Build & Test |  |
| Static analysis | |
| Coverage | |
| Citation data consistency |  |
| Downloads |  |
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.
- Linux, MacOS, or Windows with WSL (Windows Subsystem for Linux) enabled
- For Windows without WSL, please use the docker image
- Python version ≥3.9
NPLinker is a Python package, you can install it as following:
# create a new virtual environment
python -m venv env
source env/bin/activate
# install nplinker package
pip install nplinker
# install nplinker non-pypi dependencies and databases
install-nplinker-depsA virtual environment is required to install the the non-pypi dependencies. You can also use conda
to manage python environments.
See the documentation for more information about how to use NPLinker.
If you want to contribute to the development of nplinker, have a look at the contribution guidelines and README for developers.