Skip to content

Latest commit

History

History
85 lines (55 loc) 路 2 KB

getting_started.rst

File metadata and controls

85 lines (55 loc) 路 2 KB

Getting Started

gninatorch is a PyTorch implementation of GNINA scoring function, a CNN-based scoring function for molecular docking.

Note

gninatorch depends on libmolgrid, and therefore it is only available on Linux and requires a NVIDIA GPU.

If you use gninatorch, please consider citing the following papers: :cite:`ragoza2017protein`, :cite:`sunseri2020libmolgrid`, :cite:`francoeur2020three`, and :cite:`mcnutt2021gnina`.

Help

If you find an issue with gninatorch, please open a GitHub issue. If you have a question about gninatorch, please use GitHub Discussions.

Installation

Installation from Source

Clone the repository from GitHub:

git clone https://github.com/RMeli/gnina-torch.git
cd gnina-torch

Create a conda or mamba environment with all the dependencies:

conda env create -f devtools/conda-envs/gninatorch.yaml
conda activate gninatorch

Install gninatorch from source:

python -m pip install .

Installation from PyPI

python -m pip install gninatorch

Warning

Packages on PyPI are still WIP and should be considered experimental.

Testing

Run tests with pytest and report code coverage:

pytest --cov=gninatorch

.. bibliography::
   :cited: