View source for Marble/MarblePythonHello


{{TutorialBrowser|

series=Marble Python Tutorial|

name=Hello Marble|

next=[[Projects/Marble/MarblePythonMarbleWidget|Tutorial 2 - MarbleWidget: Changing basic map properties]]| 
}}


== Hello Marble! ==
The API of the Marble library allows for a very easy integration of a '''map widget''' into your application. 

Let's prove that with a tiny '''Hello world'''-like example. For a start we just create a [http://api.kde.org/pykde-4.3-api/kdeui/KApplication.html KApplication] object and a MarbleWidget object which serves as a window. 
By default the MarbleWidget uses the ''Atlas'' map theme. However for our first example we choose to display streets. So we set the maptheme id to 
[http://www.openstreetmap.org OpenStreetMap]. Then we call [http://pyqt.sourceforge.net/Docs/PyQt4/qwidget.html#show QWidget.show(self)] to show the map widget and we call [http://pyqt.sourceforge.net/Docs/PyQt4/qapplication.html QApplication.exec_()] to start the application's event loop. That's all!

<source lang="python">
from PyQt4.QtGui import *
from PyKDE4.marble import *
import sys

def main():
  # Initialize QApplication
  app = QApplication(sys.argv)

  # Create a Marble QWidget
  m = Marble.MarbleWidget()

  # Load the OpenStreeMap map
  m.setMapThemeId("earth/openstreetmap/openstreetmap.dgml")

  # Show the window
  m.show()

  # Run the app
  app.exec_()

main()
</source>

Copy and paste the code above into a text editor. Then save it as <tt>my_marble.py</tt> and run it by entering the following command on the command line:

<source lang="bash">
python my_marble.py
</source>

You end up with a fully usable OpenStreetMap application: 

[[Image:My_hello_py.png]]

{{tip|
You need PyQt, PyKDE and '''Marble development packages for Python''' (or comparable git installations)
}}
{{note|
If you provide maps in your application please check the '''Terms of Use''' of the map material. The map material that is shipped with Marble is licensed ''in the spirit of Free Software''. This usually means at least that the authors should be credited and that the license is mentioned.
E.g. for ''OpenStreetMap'' the license is [http://creativecommons.org/license/by-sa/2.0 CC-BY-SA]. Other map data shipped with Marble is either public domain or licensed in the spirit of the BSD license.
}}