Merge pull request #7 from aguinane/develop

v0.2.2

.travis.yml

@@ -3,7 +3,10 @@ language: python
 python:
   - "3.6"
 # command to run tests
-install: pip install tox-travis
+install: 
+  - pip install tox-travis coveralls
 script: tox -e $(echo py$TRAVIS_PYTHON_VERSION | tr -d .)
+after_success:
+  - coveralls
 notifications:
-  email: false
+  email: false  

README.md

@@ -1,20 +1,20 @@
 # nem-reader
 
-[![Build Status](https://travis-ci.org/aguinane/nem-reader.svg?branch=master)](https://travis-ci.org/aguinane/nem-reader)
+[![PyPI version](https://badge.fury.io/py/nemreader.svg)](https://badge.fury.io/py/nemreader) [![Build Status](https://travis-ci.org/aguinane/nem-reader.svg?branch=master)](https://travis-ci.org/aguinane/nem-reader) [![Coverage Status](https://coveralls.io/repos/github/aguinane/nem-reader/badge.svg)](https://coveralls.io/github/aguinane/nem-reader)
 
 The Australian Energy Market Operator (AEMO) defines a Meter Data File Format (MDFF) for reading energy billing data.
 [MDFF Specification](https://www.aemo.com.au/Stakeholder-Consultation/Consultations/Meter-Data-File-Format-Specification-NEM12-and-NEM13)
 
 This library sets out to parse these NEM12 (interval metering data) and NEM13 (accumulated metering data) data files into a useful python object, for use in other projects.
 
 First, read in the NEM file:
-```
+```python
 import nemreader as nr
 m = nr.read_nem_file(file_path)
 ```
 
 Then retreive the data for the NMI and channels of interest:
-```
+```python
 > print(m.header)
 HeaderRecord(version_header='NEM12', datetime=datetime.datetime(2004, 4, 20, 13, 0), from_participant='MDA1', to_participant='Ret1')
 

examples/Example_NEM12_actual_interval.csv → examples/unzipped/Example_NEM12_actual_interval.csv

@@ -1,6 +1,6 @@
-100,NEM12,200405011135,MDA1,Ret1
-200,VABD000163,E1Q1,1,E1,N1,METSER123,kWh,30,
-300,20040201,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,A,,,20040202120025,20040202142516
-200,VABD000163,E1Q1,2,Q1,,METSER123,kVArh,30,
-300,20040201,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,A,,,20040202120025,
-900
+100,NEM12,200405011135,MDA1,Ret1
+200,VABD000163,E1Q1,1,E1,N1,METSER123,kWh,30,
+300,20040201,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,1.111,A,,,20040202120025,20040202142516
+200,VABD000163,E1Q1,2,Q1,,METSER123,kVArh,30,
+300,20040201,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,2.222,A,,,20040202120025,
+900

examples/Example_NEM12_multiple_meters.csv → examples/unzipped/Example_NEM12_multiple_meters.csv

@@ -1,20 +1,20 @@
-100,NEM12,200402070911,MDA1,Ret1
-200,NCDE001111,E1B1Q1E2,1,E1,N1,METSER123,Wh,15,
-300,20031204,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,A,,,20031206011132,20031207011022
-300,20031205,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,A,,,20031206011132,20031207011022
-200,NCDE001111,E1B1Q1E2,2,B1,N1,METSER123,Wh,15,
-300,20031204,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,A,,,20031206011132,20031207011022
-300,20031205,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,A,,,20031206011132,20031207011022
-200,NCDE001111,E1B1Q1E2,3,Q1,,METSER123,VArh,15,
-300,20031204,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,A,,,20031206011155,
-300,20031205,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,A,,,20031206011155,
-200,NCDE001111,E1B1Q1E2,4,E2,N2,METSER456,Wh,15,
-300,20031204,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,A,,,20031206011140,20031207011022
-300,20031205,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,A,,,20031206011140,20031207011022
-200,NDDD001888,B1K2,1,B1,N1,METSER991,Wh,15,
-300,20031204,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,A,,,20031206011145,20031207011022
-300,20031205,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,A,,,20031206011145,20031207011022
-200,NDDD001888,B1K2,2,K2,,METSER992,VArh,15,
-300,20031204,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,A,,,20031206011155,
-300,20031205,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,A,,,20031206011155,
+100,NEM12,200402070911,MDA1,Ret1
+200,NCDE001111,E1B1Q1E2,1,E1,N1,METSER123,Wh,15,
+300,20031204,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,A,,,20031206011132,20031207011022
+300,20031205,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,A,,,20031206011132,20031207011022
+200,NCDE001111,E1B1Q1E2,2,B1,N1,METSER123,Wh,15,
+300,20031204,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,A,,,20031206011132,20031207011022
+300,20031205,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,A,,,20031206011132,20031207011022
+200,NCDE001111,E1B1Q1E2,3,Q1,,METSER123,VArh,15,
+300,20031204,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,A,,,20031206011155,
+300,20031205,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,A,,,20031206011155,
+200,NCDE001111,E1B1Q1E2,4,E2,N2,METSER456,Wh,15,
+300,20031204,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,A,,,20031206011140,20031207011022
+300,20031205,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,A,,,20031206011140,20031207011022
+200,NDDD001888,B1K2,1,B1,N1,METSER991,Wh,15,
+300,20031204,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,A,,,20031206011145,20031207011022
+300,20031205,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,A,,,20031206011145,20031207011022
+200,NDDD001888,B1K2,2,K2,,METSER992,VArh,15,
+300,20031204,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,A,,,20031206011155,
+300,20031205,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,50,A,,,20031206011155,
 900

examples/Example_NEM12_multiple_quality.csv → examples/unzipped/Example_NEM12_multiple_quality.csv

@@ -1,7 +1,7 @@
-100,NEM12,200404201300,MDA1,Ret1
-200,CCCC123456,E1,001,E1,N1,METSER123,kWh,30,
-300,20040417,18.023,19.150,17.592,24.155,18.568,22.304,19.222,19.032,19.090,22.237,24.350,22.274,20.193,16.615,19.575,20.391,16.459,20.527,21.438,19.327,21.424,16.656,17.616,18.416,16.666,19.961,18.120,18.023,18.588,21.759,17.841,19.548,18.486,21.391,15.656,16.634,16.377,14.246,17.451,15.742,18.038,18.470,14.936,17.987,15.751,19.750,16.202,14.733,V,,,20040418203500,20040419003500
-400,1,20,F14,76,
-400,21,24,A,,
-400,25,48,S14,1,
-900
+100,NEM12,200404201300,MDA1,Ret1
+200,CCCC123456,E1,001,E1,N1,METSER123,kWh,30,
+300,20040417,18.023,19.150,17.592,24.155,18.568,22.304,19.222,19.032,19.090,22.237,24.350,22.274,20.193,16.615,19.575,20.391,16.459,20.527,21.438,19.327,21.424,16.656,17.616,18.416,16.666,19.961,18.120,18.023,18.588,21.759,17.841,19.548,18.486,21.391,15.656,16.634,16.377,14.246,17.451,15.742,18.038,18.470,14.936,17.987,15.751,19.750,16.202,14.733,V,,,20040418203500,20040419003500
+400,1,20,F14,76,
+400,21,24,A,,
+400,25,48,S14,1,
+900

examples/Example_NEM12_substituted_interval.csv → examples/unzipped/Example_NEM12_substituted_interval.csv

@@ -1,6 +1,6 @@
-100,NEM12,200309010132,MDA1,Ret1
-200,VBCD000022,E1Q1,1,E1,N1,METSER223,kWh,30,
-300,20030801,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,F14,32,,20030802125725,20030804025521
-200,VBCD000022,E1Q1,2,Q1,,METSER223,kVArh,30,
-300,20030801,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,22.123,22.123,22.123,22.123,22.123,22.123,22.123,22.123,22.123,22.123,22.123,22.123,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,F14,32,,20030802125725,
-900
+100,NEM12,200309010132,MDA1,Ret1
+200,VBCD000022,E1Q1,1,E1,N1,METSER223,kWh,30,
+300,20030801,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,2.312,F14,32,,20030802125725,20030804025521
+200,VBCD000022,E1Q1,2,Q1,,METSER223,kVArh,30,
+300,20030801,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,34.567,22.123,22.123,22.123,22.123,22.123,22.123,22.123,22.123,22.123,22.123,22.123,22.123,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,2311.765,F14,32,,20030802125725,
+900

examples/Example_NEM13_consumption_data.csv → examples/unzipped/Example_NEM13_consumption_data.csv

@@ -1,3 +1,3 @@
-100,NEM13,200401101030,MDA1,Ret1
-250,VABC005890,11,1,11,11,METSER123,E,006342.8,20031005093055,A,,,007654.9,20040107100333,A,,,1312.1,kWh,20040407, 20040108100333,20040108091133
-900
+100,NEM13,200401101030,MDA1,Ret1
+250,VABC005890,11,1,11,11,METSER123,E,006342.8,20031005093055,A,,,007654.9,20040107100333,A,,,1312.1,kWh,20040407, 20040108100333,20040108091133
+900

examples/Example_NEM13_forward_estimate.csv → examples/unzipped/Example_NEM13_forward_estimate.csv

@@ -1,6 +1,6 @@
-100,NEM13,200401101030,MDA1,Ret1
-250,VDEF005890,1141,1,11,11,MET12345,E,000888,20040108103055,A,,,000999,20040408000000,E64,,,111,kWh,20040408, 20040409000000,20040109103023
-550,N,,E,
-250,VDEF005890,1141,2,41,41,MET5678,E,0000950,20040108103055,A,,,0010015,20040408000000,E64,,,65,kWh,20040408, 20040409000000,20040109103023
-550,N,,E,
-900
+100,NEM13,200401101030,MDA1,Ret1
+250,VDEF005890,1141,1,11,11,MET12345,E,000888,20040108103055,A,,,000999,20040408000000,E64,,,111,kWh,20040408, 20040409000000,20040109103023
+550,N,,E,
+250,VDEF005890,1141,2,41,41,MET5678,E,0000950,20040108103055,A,,,0010015,20040408000000,E64,,,65,kWh,20040408, 20040409000000,20040109103023
+550,N,,E,
+900

nemreader/nem_objects.py

@@ -34,7 +34,9 @@
     ['version_header',
      'datetime',
      'from_participant',
-     'to_participant']
+     'to_participant',
+     'file_name',
+     ]
 )