pieface 1.1.0

****************************************************** ************************************
用于协调环境分析的多面体刻划椭圆体 (PIEFACE)
****** ****************************************************** ******************************


.. 图片:: https://readthedocs.org/projects/pieface/badge/?version=latest
:target: http://pieface.readthedocs.io/en/latest/?badge=latest
.. 图片:: https://travis-ci.org/jcumby/PIEFACE.svg?branch=master
:target: https: //travis-ci.org/jcumby/PIEFACE

============
简介
============

**P**\ olyhedra **I**\ nscribing **E**\ 椭球体 **F**\ 或 **A**\ 分析 **C**\ 配位 **E**\ nvironments （或 PIEFACE）是一个开源 Python 项目，用于
分析化学配位多面体的扭曲。
使用最小边界椭球 (MBE) 方法进行分析；可以包围所有多面体顶点的最小体积椭球。
结果非常普遍，并且与多面体的大小或变形的性质无关。因此，该方法已应用于一系列晶体学
情况。

有关详细信息，请参阅`在线文档 <http://pieface.readthedocs.io/>`_。

============
安装
=============

有关详细说明，请参阅“安装”_。在 Windows 上，最简单的方法是下载并运行最新的 PIEFACE Windows Installer `release <https://github.com/jcumby/PIEFACE/releases/latest>`_。

====================
许可证和引用
=====================

PIEFACE 是开源的，分布式的根据`MIT许可<http://pieface.readthedocs.io/en/latest/license.html>`_。

使用软件应引用文章：

J\。Cumby 和 JP Attfield，协调多面体的椭圆体分析，Nature Communications 14235 (2017)。


=====
用法
=====

---------
基本用法
---------

PIEFACE 提供两个实用程序，方便使用；一个命令行程序（``CIFellipsoid``）和一个图形界面（``EllipsoidGUI``）。
这些允许读取一个或多个 CIF 文件、确定配位多面体和拟合椭圆体。生成的椭球
参数可以保存到文本文件并以交互方式查看。

安装后，图形界面可以通过在命令行中键入``EllipsoidGUI`` 或单击开始菜单图标来启动（如果使用`Windows Installer <https://github.com/jcumby/PIEFACE/releases/最新>`_）。

命令行应用程序可以通过键入带有适当参数的“CIFellipsoid”来运行：

CIFellipsoid CIF1 [CIF2 CIF3...] -m <polyhedron center> -r <max bond length> -l <​​ligand types>

这将生成一个椭球参数的输出文件 (CIF.TXT) 和一个椭球的 3D 图以及有用的椭球参数摘要。

许多其他选项也可用；键入 ``CIFellipsoid --help`` 以获取详细信息，从 ``EllipsoidGUI`` 中打开帮助或查看 `Script Help`_。

------------
高级使用
------------

对于更复杂的用例，可以将包导入并用作python包：

import pieface phase

, plots = pieface.calcellipsoid.calcfromcif([list of CIFs], [list of centres], **kwargs)


这将（默认情况下）并行处理所有 CIF 文件（对于脚本）。``kwargs`` 是``CIFellipsoid`` 可用的许多选项；最重要的是

* ligtypes 或 lignames（为中心指定正确的配体）
* 半径（用于键搜索）
* 容差（用于拟合容差）

也可以导入包中的各个模块（即``pieface.ellipsoid``）以执行特定功能：阅读
源代码中的文档以获取更多详细信息或查看`API参考`_。

-------
示例
-------

参见`教程`_。

----
帮助
----

可以通过以下方式访问帮助：

* `在线文档 <http://pieface.readthedocs.io/>`_
* 帮助菜单中的 ``EllipsoidGUI``
* ``CIFellipsoid --help ``

=======
测试
=======

该软件包包含一些基本的单元测试，可以使用以下命令运行：

python setup.py test

所有测试都应该通过，如果没有，请给我发送错误报告。

==========
免责声明
==========

本软件在尽力而为的基础上按原样提供。作者不承担与使用该软件相关的任何责任。
它已针对许多案例的结果准确性进行了测试，但仅限于作者能想到的用途。我们很想
听听有关新用途或软件潜在添加的任何建议。

我们将尽最大努力纠正任何发现的错误！

=======
作者
=======

James Cumby - james.cumby@ed.ac.uk

.. _docshome: http://pieface.readthedocs.io/
.. _introduction: http://pieface.readthedocs.io/en/latest/introduction.html
.. _Tutorials ：http ://pieface.readthedocs.io/en/latest/tutorial.html
.._安装：http:
//pieface.readthedocs.io/en/latest/installation.html .._下载：https://github.com /jcumby/PIEFACE/releases/latest
.. _脚本帮助：http:
//pieface.readthedocs.io/en/latest/script_input.html .. _API 参考：http ://pieface.readthedocs.io/en/latest/api_reference .html