Skip to content

Commit

Permalink
enhance readme
Browse files Browse the repository at this point in the history
  • Loading branch information
c-moeller committed Nov 27, 2015
1 parent c1dc37e commit 4dd9580
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,50 +1,51 @@
Oemof stands for "Open Energy System Modeling Framework" and provides a free, open source and clearly documented model to analyse energy supply systems, developed in Python. It is designed as a framework with a modular structure and has several packages which communicate through well defined interfaces.
Oemof stands for "Open Energy System Modeling Framework" and provides a free, open source and clearly documented model to analyse energy supply systems. It is developed in Python and designed as a framework with a modular structure containing several packages which communicate through well defined interfaces.

With oemof_base we provide base packages for energy system modeling and optimization.

Documentation
=============

Full documentation can be found at **LINK**.
Full documentation can be found at http://www.pythonhosted.org/oemof_base/.

Contribution
============

We highly encourage you to contribute to further development of oemof. If you want to collaborate see description below or contact us.
Installing oemof_base
=====================

Usage
=====
.. code:: bash
Using oemof
-----------
sudo pip3 install oemof_base
.. code:: bash
Developing oemof_base
=====================

sudo pip3 install oemof
We highly encourage you to contribute to further development of oemof. If you want to collaborate see description below or contact us.

Developing oemof
----------------
To install the developer version two steps are necessary:

.. code:: bash
git clone git@github.com:oemof/oemof_base.git
sudo pip3 install -e /path/to/the/repository
See **LINK** for further information.

Installation
------------
See http://www.pythonhosted.org/oemof_base/installation_and_setup.html for further information.

**LINK**
Further packages within oemof
==============================

feedinlib, oemof_pg ?
`Feedinlib <https://github.com/oemof/feedinlib>`_ and `oemof_pg <https://github.com/oemof/oemof_pg>`_ are part of the oemof framework. They can be used to create energy system models but are not a must.

Examples
--------
========

`Storage optimization <https://github.com/oemof/oemof_base/tree/master/examples/storage_optimization>`_
The linkage of specific modules of the various packages is called an application (app) and depicts for example a concrete energy system model.

`Development examples <https://github.com/oemof/oemof_base/tree/master/examples/development_examples>`_
There is one executable example energy system in `Storage optimization <https://github.com/oemof/oemof_base/tree/master/examples/storage_optimization>`_.

Further example apps in development can be found in
`Development examples <https://github.com/oemof/oemof_base/tree/master/examples/development_examples>`_.

License
-------
=======

Copyright (C) 2015 oemof developing group

Expand All @@ -59,5 +60,4 @@ 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/>.

along with this program. If not, see <http://www.gnu.org/licenses/>.

0 comments on commit 4dd9580

Please sign in to comment.