File: index.rst

package info (click to toggle)
python-ihm 2.7-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 3,368 kB
  • sloc: python: 30,422; ansic: 5,990; sh: 24; makefile: 20
file content (59 lines) | stat: -rw-r--r-- 1,045 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
Python-IHM documentation
========================

This is a Python package to assist in handling mmCIF files compliant
with the integrative/hybrid modeling (IHM) extension.

The documentation below documents the library API. For complete worked examples,
see `the examples directory at GitHub <https://github.com/ihmwg/python-ihm/tree/main/examples>`_
or real systems deposited using the library, such as
`Nup133 <https://github.com/integrativemodeling/nup133/tree/main/outputs_foxs_ensemble_new/pdb-dev>`_.

Contents
========

.. toctree::
   :maxdepth: 2

   introduction
   usage
   provenance
   design
   lowlevel
   changes

API Reference:

.. toctree::
   :maxdepth: 1

   main
   source
   reference
   location
   dataset
   metadata
   startmodel
   representation
   geometry
   restraint
   cross_linkers
   citations
   protocol
   analysis
   model
   format
   format_bcif
   dumper
   reader
   dictionary
   flr
   multi_state_scheme


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

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