Commit version 1.0.0

README.md

@@ -0,0 +1,118 @@
+# DTOcean Electrical Sub-Systems Module
+
+## Installation
+
+### Install Anaconda Python
+
+The recommended Python distribution for testing the Electical Sub-Systems module
+is [Anaconda Python](https://www.continuum.io/downloads). Download the 
+**Windows Python 2.7** installer and execute it.
+
+Note: It is recommended that you install Anaconda for **All Users** (not the
+default local user) and that you allow Anaconda to become the system Python
+version. Other options may work, but we can not provide support if Anaconda is
+installed in a different manner.
+
+### Add Public Anaconda Cloud channel
+
+To download some of the dependencies the following channel must be
+added to Ananconda:
+
+```
+conda config --add channels https://conda.anaconda.org/topper
+```
+
+### Set up an Anaconda environment
+
+Using a windows command prompt enter the following commands:
+
+```
+conda create -n dtocean_elec python pip pytest ipython-notebook
+```
+
+then, to activate the environment:
+
+```
+activate dtocean_elec
+```
+
+or
+
+```
+C:\Anaconda\Scripts\activate.bat dtocean_elec
+```
+
+**You must activate the environment every time you use the module.**
+
+### Install Package Dependencies
+
+```
+conda install descartes matplotlib networkx numpy openpyxl pandas pypower scipy shapely-win-py27 xlrd xlwt
+```
+
+### Install "beta" Module Package
+
+Three packages must be installed from the "beta"
+branches of the Hg repositories found in
+https://bitbucket.org/team_dtocean/dtocean-electrical.
+
+The repositories are managed using [Mercurial](https://www.mercurial-scm.org/)
+and if you wish to download the entire repository then the recommended software
+is [TortoiseHg](http://tortoisehg.bitbucket.org/).
+
+A direct link to the current beta version is also available, here:
+
+https://bitbucket.org/team_dtocean/dtocean-electrical/get/beta.zip
+
+Once cloned or extracted to a particular directory the module is installed
+using the following commands:
+
+```
+cd path\to\dtocean-electrical
+winmake.bat install
+```
+
+Remember to replace "path\to\" with the real path to the folder containing the
+module source code.
+
+## Testing
+
+### Unit Tests
+
+Unit tests will run automatically as part of the package installation process. 
+They can be re-run using the command:
+
+```
+activate dtocean_elec
+cd path\to\package
+winmake.bat test
+```
+
+Note, you only need to activate the Anaconda environment once per session.
+
+### Jupyter Notebooks
+
+Examples of using the mdoule are given in [Jupyter Notebooks](http://jupyter.org/)
+which are found in the "notebooks" folder of the dtocean-electrical source code.
+The notebooks should be started from the Anaconda environment as follows:
+
+```
+activate dtocean_elec
+start jupyter notebook
+```
+
+Note, you only need to activate the Anaconda environment once per session.
+
+**It is important that the test data found in the "sample_data" directory is
+copied into the same directory where the notebooks are being executed from**.
+You can customise this directory using the config file described
+[here](http://jupyter-notebook.readthedocs.io/en/latest/config.html)
+and setting the "notebook_dir" variable.
+
+Once the test data has been placed alongside the notebook, the notebook can be
+executed in the normal way.
+
+## DTOcean Project
+
+DTOcean - "Optimal Design Tools for Ocean Energy Arrays" is funded by the 
+European Commission’s 7th Framework Programme. Grant agreement number: 608597

dtocean_electrical/__init__.py

@@ -0,0 +1,29 @@
+
+import logging
+
+from polite.paths import ObjDirectory, UserDataDirectory, DirectoryMap
+from polite.configuration import Logger
+
+# Set default logging handler to avoid "No handler found" warnings.
+try:  # Python 2.7+
+    from logging import NullHandler
+except ImportError:
+    class NullHandler(logging.Handler):
+        def emit(self, record):
+            pass
+
+logging.getLogger(__name__).addHandler(NullHandler())
+
+def start_logging(level=None):
+
+    """Start python logger"""
+
+    objdir = ObjDirectory(__name__, "config")
+    datadir = UserDataDirectory("dtocean_electrical", "DTOcean", "config")
+    dirmap = DirectoryMap(datadir, objdir)
+
+    log = Logger(dirmap)
+    log("dtocean_electrical",
+        level=level,
+        info_message="Begin logging for dtocean_electrical.")
+

dtocean_electrical/config/logging.yaml

@@ -0,0 +1,28 @@
+---
+version: 1
+disable_existing_loggers: False
+formatters:
+  simple:
+    format: '%(asctime)s - %(levelname)s - %(name)s - %(message)s'
+handlers:
+  null:
+    class: logging.NullHandler
+  console:
+    class: logging.StreamHandler
+    level: DEBUG
+    formatter: simple
+    stream: ext://sys.stdout
+  file:
+    class : logging.FileHandler
+    formatter: simple
+    level: DEBUG
+    filename: dtocean-electrical.log
+loggers:
+  'dtocean_electrical':
+    level: DEBUG
+    handlers: [console]
+    propagate: no
+root:
+  level: DEBUG
+  handlers: [console]
+

dtocean_electrical/grid/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/python2.7
+# encoding: utf-8