README.rst

   1 |travis| |pythons| |wheel|
   2
   3 **Development Status**
   4
   5 PyCIM has proven to be more popular than first anticipated.
   6 However, it has not received the support and updates it requires. Should
   7 improvements such as:
   8
   9 - CIM 16/CGMES support,
  10 - Difference models or
  11 - Topological processing
  12
  13 be required then the `original author <https://github.com/rwl>`_
  14 may be available on contract. Please do not hesitate to get in
  15 `contact <mailto:r.w.lincoln@gmail.com>`_ directly.
  16
  17 ============
  18 Introduction
  19 ============
  20
  21 PyCIM is a Python implementation of the IEC Common Information Model.
  22
  23 Current features include:
  24
  25 - Support for IEC 61970 15v13 and IEC 61968 11v05,
  26 - Legacy support for IEC 61970 14v15 and IEC 61968 10v31,
  27 - Profiles of the CIM, including:
  28   - Common Power Systems Model (CPSM) (CIM v14)
  29   - Common Distribution Power System Model (CDPSM) (CIM v14 and v15)
  30   - European Network of Transmission System Operators for Electricity
  31   (ENTSO-E) (CIM v14),
  32 - Class and attribute documentation integrated as Python doc-strings,
  33 - Transparent bi-directional reference handling using Python properties,
  34 - CIM RDF/XML parsing and serialisation according to IEC 61970-552.
  35
  36 Installation
  37 ------------
  38
  39 PyCIM has no dependencies beyond Python_ 2.6 or later. It can be easy_installed
  40 using setuptools_::
  41
  42   $ easy_install PyCIM
  43
  44 Alternatively, download and unpack the tarball and install::
  45
  46   $ tar zxf PyCIM-XX.XX.tar.gz
  47   $ python setup.py install
  48
  49 On UNIX systems, use sudo for the latter command if you need to install the
  50 scripts to a directory that requires root privileges::
  51
  52   $ sudo python setup.py install
  53
  54 The development Git_ repository can be cloned from GitHub_::
  55
  56   $ git clone https://github.com/rwl/PyCIM.git
  57
  58 Quick start
  59 -----------
  60
  61 To parse a CIM RDF/XML file::
  62
  63   In[1]: import logging
  64
  65   In[2]: logging.basicConfig(level=logging.INFO)
  66
  67   In[3]: from PyCIM import cimread
  68
  69   In[4]: d = cimread('path/to/input_file.xml')
  70   INFO:PyCIM.RDFXMLReader:Created 5660 CIM objects in 1.04s.
  71
  72 The ``cimread`` function returns a Python dictionary that maps UUIDs to CIM
  73 objects.  To serialise the dictionary of objects::
  74
  75   In[5]: from PyCIM import cimwrite
  76
  77   In[6]: cimwrite(d, 'path/to/output_file.xml')
  78   INFO:PyCIM.RDFXMLWriter:5660 CIM objects serialised in 1.14s.
  79
  80 For further information refer to the website_ and the `API documentation`_.
  81
  82 License
  83 -------
  84
  85 Permission is hereby granted, free of charge, to any person obtaining a copy
  86 of this software and associated documentation files (the "Software"), to
  87 deal in the Software without restriction, including without limitation the
  88 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  89 sell copies of the Software, and to permit persons to whom the Software is
  90 furnished to do so, subject to the following conditions:
  91
  92 The above copyright notice and this permission notice shall be included in
  93 all copies or substantial portions of the Software.
  94
  95 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  96 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  97 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  98 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  99 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 100 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 101 IN THE SOFTWARE.
 102
 103 Credits
 104 -------
 105
 106 PyCIM is developed by Richard Lincoln (r.w.lincoln@gmail.com).
 107
 108 .. _Python: http://www.python.org/
 109 .. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools/
 110 .. _Git: http://git-scm.com/
 111 .. _GitHub: http://github.com/
 112 .. _iPython: http://ipython.scipy.org
 113 .. _`website`: http://rwl.github.io/PyCIM/
 114 .. _`API documentation`: http://rwl.github.io/PyCIM/api/
 115
 116 .. more shields at http://shields.io
 117 .. |travis| image:: https://travis-ci.org/rwl/PyCIM.svg?branch=master
 118     :target: https://travis-ci.org/rwl/PyCIM
 119 .. |pythons| image:: https://img.shields.io/pypi/pyversions/PyCIM.svg
 120     :target: https://pypi.python.org/pypi/PyCIM
 121 .. |wheel| image:: https://img.shields.io/pypi/format/PyCIM.svg
 122     :target: https://pypi.python.org/pypi/PyCIM