README.rst

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