Skip to main content

mmCIF Core Access Library

Project description

mmCIF Core Access Library

Build Status

Introduction

This module includes a native Python mmCIF API for data files and dictionaries along with pybind11 wrappers for the PDB C++ Core mmCIF Library.

Installation

Download the library source software from the project repository:

git clone  --recurse-submodules  https://github.com/rcsb/py-mmcif.git

Optionally, run test suite using the Tox test runner. The C++ library bindings have been tested on Centos 7/Ubuntu 20.04 Linux with GCC/G++ > 4.8.5 and MacOS (10.15) with > clang-900.0.39.2 using Python versions 2.7.18 and 3.9.4.

tox

Installation is via the program pip.

pip install mmcif

or from the local repository:

pip install .

To generate API documentation using Sphinx:

cd scripts
# Check Sphinx dependencies in the introductory comments to the following script.
./initdocs.sh

A command-line script is provided as a preprocessor for modular dictionaries that include definition and data content using categories pdbx_include_dictionary, pdbx_include_category and pdbx_include_item.

build_dict_cli --help
usage: build_dict_cli [-h] --op OP --input_dict_path INPUT_DICT_PATH [--output_dict_path OUTPUT_DICT_PATH] [--cleanup]

optional arguments:
  -h, --help            show this help message and exit
  --op OP               Operation (build | get_version)
  --input_dict_path INPUT_DICT_PATH
                        Path to dictionary generator file
  --output_dict_path OUTPUT_DICT_PATH
                        Path to output dictionary text file
  --cleanup             Remove include instruction categories after processing
________________________________________________________________________________

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mmcif-0.89.0.tar.gz (1.7 MB view hashes)

Uploaded Source

Built Distributions

mmcif-0.89.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (617.9 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

mmcif-0.89.0-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl (635.1 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ i686

mmcif-0.89.0-cp312-cp312-macosx_11_0_arm64.whl (520.6 kB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

mmcif-0.89.0-cp312-cp312-macosx_10_9_x86_64.whl (562.6 kB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

mmcif-0.89.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (617.3 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

mmcif-0.89.0-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl (635.3 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ i686

mmcif-0.89.0-cp311-cp311-macosx_11_0_arm64.whl (516.2 kB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

mmcif-0.89.0-cp311-cp311-macosx_10_9_x86_64.whl (552.1 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

mmcif-0.89.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (617.5 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

mmcif-0.89.0-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl (634.7 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686

mmcif-0.89.0-cp310-cp310-macosx_11_0_arm64.whl (516.2 kB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

mmcif-0.89.0-cp310-cp310-macosx_10_9_x86_64.whl (552.2 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

mmcif-0.89.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (617.7 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

mmcif-0.89.0-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl (634.8 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686

mmcif-0.89.0-cp39-cp39-macosx_11_0_arm64.whl (516.3 kB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

mmcif-0.89.0-cp39-cp39-macosx_10_9_x86_64.whl (552.3 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

mmcif-0.89.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (617.3 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

mmcif-0.89.0-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl (634.3 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ i686

mmcif-0.89.0-cp38-cp38-macosx_11_0_arm64.whl (516.3 kB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

mmcif-0.89.0-cp38-cp38-macosx_10_9_x86_64.whl (552.3 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

mmcif-0.89.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (631.9 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

mmcif-0.89.0-cp37-cp37m-manylinux_2_17_i686.manylinux2014_i686.whl (651.0 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ i686

mmcif-0.89.0-cp37-cp37m-macosx_10_9_x86_64.whl (545.1 kB view hashes)

Uploaded CPython 3.7m macOS 10.9+ x86-64

mmcif-0.89.0-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (632.1 kB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ x86-64

mmcif-0.89.0-cp36-cp36m-manylinux_2_17_i686.manylinux2014_i686.whl (651.0 kB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ i686

mmcif-0.89.0-cp36-cp36m-macosx_10_9_x86_64.whl (544.5 kB view hashes)

Uploaded CPython 3.6m macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page