Apache 2.0 license

calliope/constraints/base.py

@@ -1,3 +1,14 @@
+"""
+Copyright (C) 2013 Stefan Pfenninger.
+Licensed under the Apache 2.0 License (see LICENSE file).
+
+base.py
+~~~~~~~
+
+Basic model constraints.
+
+"""
+
 from __future__ import print_function
 from __future__ import division
 

calliope/constraints/ramping.py

@@ -1,3 +1,14 @@
+"""
+Copyright (C) 2013 Stefan Pfenninger.
+Licensed under the Apache 2.0 License (see LICENSE file).
+
+ramping.py
+~~~~~~~~~~
+
+Ramping constraints.
+
+"""
+
 from __future__ import print_function
 from __future__ import division
 

calliope/core.py

@@ -1,3 +1,14 @@
+"""
+Copyright (C) 2013 Stefan Pfenninger.
+Licensed under the Apache 2.0 License (see LICENSE file).
+
+core.py
+~~~~~~~
+
+Core model functionality via the Model class.
+
+"""
+
 from __future__ import print_function
 from __future__ import division
 

calliope/locations.py

@@ -1,5 +1,12 @@
 """
-Functions to deal with locations and their configuration
+Copyright (C) 2013 Stefan Pfenninger.
+Licensed under the Apache 2.0 License (see LICENSE file).
+
+locations.py
+~~~~~~~~~~~~
+
+Functions to deal with locations and their configuration.
+
 """
 
 from __future__ import print_function

calliope/parallel.py

@@ -1,3 +1,15 @@
+"""
+Copyright (C) 2013 Stefan Pfenninger.
+Licensed under the Apache 2.0 License (see LICENSE file).
+
+parallel.py
+~~~~~~~~~~~
+
+Defines the Parallelizer class which manages the creation of arbitrary
+numbers of scripted runs, either locally or to be deployed to a cluster.
+
+"""
+
 from __future__ import print_function
 from __future__ import division
 

calliope/parallel_tools.py

@@ -1,3 +1,14 @@
+"""
+Copyright (C) 2013 Stefan Pfenninger.
+Licensed under the Apache 2.0 License (see LICENSE file).
+
+parallel_tools.py
+~~~~~~~~~~~~~~~~~
+
+Functions to process results from parallel runs created by parallel.py.
+
+"""
+
 from __future__ import print_function
 from __future__ import division
 

calliope/techs.py

@@ -1,3 +1,15 @@
+"""
+Copyright (C) 2013 Stefan Pfenninger.
+Licensed under the Apache 2.0 License (see LICENSE file).
+
+techs.py
+~~~~~~~~
+
+Basic Technology class and additional custom classes for technologies to
+perform custom initialization tasks during model initialization.
+
+"""
+
 from __future__ import print_function
 from __future__ import division
 

calliope/time.py

@@ -1,3 +1,15 @@
+"""
+Copyright (C) 2013 Stefan Pfenninger.
+Licensed under the Apache 2.0 License (see LICENSE file).
+
+time.py
+~~~~~~~
+
+Provides the TimeSummarizer class which can dynamically adjust the time
+step resolution of the data in a model instance.
+
+"""
+
 from __future__ import print_function
 from __future__ import division
 

calliope/time_masks.py

@@ -1,3 +1,15 @@
+"""
+Copyright (C) 2013 Stefan Pfenninger.
+Licensed under the Apache 2.0 License (see LICENSE file).
+
+time_masks.py
+~~~~~~~~~~~~~
+
+Defines time masks to be used with TimeSummarizer in time.py.
+
+"""
+
+
 from __future__ import print_function
 from __future__ import division
 

calliope/transmission.py

@@ -1,5 +1,12 @@
 """
-Functions to deal with transmission between locations
+Copyright (C) 2013 Stefan Pfenninger.
+Licensed under the Apache 2.0 License (see LICENSE file).
+
+transmission.py
+~~~~~~~~~~~~~~~
+
+Functions to deal with transmission between locations.
+
 """
 
 from __future__ import print_function

calliope/utils.py

@@ -1,3 +1,15 @@
+"""
+Copyright (C) 2013 Stefan Pfenninger.
+Licensed under the Apache 2.0 License (see LICENSE file).
+
+utils.py
+~~~~~~~~
+
+Various utility functions, particularly the AttrDict class (a subclass
+of regular dict) used for managing model configuration.
+
+"""
+
 from __future__ import print_function
 from __future__ import division
 

changelog.rst

@@ -11,6 +11,7 @@ Release History
 * Ability to arbitrarily nest model configuration files with ``import`` statements
 * Cleared up terminology (nodes vs locations)
 * Improved documentation
+* Apache 2.0 licensed
 * Other improvements
 
 0.1.0 (2013-12-10)

doc/_templates/sidebar_intro.html

@@ -6,5 +6,5 @@
 
 <!-- <p style="text-align:justify; font-size: 0.9em;"> -->
 <p>
-  Calliope is a framework to develop energy systems models using a modern Python-based toolchain.
+  Calliope is a framework to develop energy systems models using a modern and open source Python-based toolchain.
 </p>

doc/_themes/flask_calliope/layout.html

@@ -17,7 +17,7 @@
 {%- block footer %}
   <div class="footer">
     &copy; Copyright {{ copyright }}.
-    Docs created using <a href="http://sphinx-doc.org/">Sphinx</a>.
+    <!-- Docs created using <a href="http://sphinx-doc.org/">Sphinx</a>. -->
   </div>
   {% if pagename == 'index' %}
   </div>

doc/api/api.rst

@@ -18,23 +18,23 @@ Constraints
 .. automodule:: calliope.constraints.ramping
     :members:
 
-Utilities
-=========
+AttrDict
+========
 
-.. automodule:: calliope.utils
+.. autoclass:: calliope.utils.AttrDict
     :members:
 
-Parallelization
-===============
+Parallelizer and parallel_tools
+===============================
 
 .. autoclass:: calliope.Parallelizer
     :members:
 
 .. automodule:: calliope.parallel_tools
-    :members:
+    :members: read_dir, reshape_results
 
-Time
-===============
+TimeSummarizer
+==============
 
 .. autoclass:: calliope.TimeSummarizer
     :members:

doc/conf.py

@@ -44,7 +44,7 @@
 
 # General information about the project.
 project = u'Calliope'
-copyright = u'2013, Stefan Pfenninger'
+copyright = u'2013, Stefan Pfenninger (Apache 2.0 licensed)'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -248,3 +248,16 @@
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 #texinfo_show_urls = 'footnote'
+
+
+#
+# Remove module docstrings from autodoc
+#
+
+def remove_module_docstring(app, what, name, obj, options, lines):
+    if what == "module":
+        del lines[:]
+
+
+def setup(app):
+    app.connect("autodoc-process-docstring", remove_module_docstring)

doc/index.rst

@@ -6,7 +6,7 @@ Calliope: a multi-scale energy systems (MUSES) modeling framework
 
 v\ |version| (:doc:`Release history <history>`)
 
-Calliope is a framework to develop energy systems models using a modern Python-based toolchain.
+Calliope is a framework to develop energy systems models using a modern and open source Python-based toolchain.
 
 Main features:
 
@@ -17,7 +17,7 @@ Main features:
 * Able to run on computing clusters
 * Easily extensible
 * Uses a state-of-the-art Python toolchain based on `IPython <http://ipython.org/>`_, `Pandas <http://pandas.pydata.org/>`_ and `Pyomo <https://software.sandia.gov/trac/coopr/wiki/Pyomo>`_
-* `Freely available <https://github.com/sjpfenninger/calliope>`_ under the GNU GPLv3 license
+* `Freely available <https://github.com/sjpfenninger/calliope>`_ under the Apache 2.0 license
 
 -----------
 Quick start
@@ -76,18 +76,16 @@ Release history
 License
 -------
 
-Copyright © 2013  Stefan Pfenninger
+Copyright 2013 Stefan Pfenninger
 
-This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along with this program.  If not, see [http://www.gnu.org/licenses/].
-
-.. Indices and tables
-.. ==================
-..
-.. * :ref:`genindex`
-.. * :ref:`modindex`
-.. * :ref:`search`
+   http://www.apache.org/licenses/LICENSE-2.0
 
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

doc/model/introduction.rst

@@ -9,14 +9,22 @@ Acknowledgments
 
 Development is funded by the `Grantham Institute for Climate Change <http://www3.imperial.ac.uk/climatechange/>`_ at Imperial College London and the European Institute of Technology's `Climate-KIC program <http://www.climate-kic.org>`_.
 
+.. _license:
+
 -------
 License
 -------
 
-Copyright © 2013  Stefan Pfenninger
+Copyright 2013 Stefan Pfenninger
 
-This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+   http://www.apache.org/licenses/LICENSE-2.0
 
-You should have received a copy of the GNU General Public License along with this program.  If not, see [http://www.gnu.org/licenses/].
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.