.. pdb_numpy documentation master file, created by
   sphinx-quickstart on Thu Jan 12 11:14:44 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PDB-numpy's documentation!
=====================================

.. warning::

   ``pdb_numpy`` is deprecated and no longer actively maintained. Please migrate to
   `pdb_cpp <https://github.com/samuelmurail/pdb_cpp>`_, the successor library which
   provides improved performance and additional features.

.. image:: https://raw.githubusercontent.com/samuelmurail/pdb_numpy/master/docs/source/logo.jpeg
  :width: 300
  :align: center
  :alt: PDB Numpy Logo

|

``pdb_numpy`` is a python library designed to facilitate working with coordinates files
in the context of structural bioinformatics. The library builds upon the
powerful ``numpy`` library to provide efficient and easy-to-use tools for
reading, manipulating, and analyzing coordinates files.

.. toctree::
   :maxdepth: 4
   :caption: Table of Contents:

   readme
   installation
   basic_example
   Github project <https://github.com/samuelmurail/pdb_numpy>
   pdb_numpy

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`