Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

Complete documentation for Metview's Python interface is now available on readthedocs!


Metview's Python interface provides access to all of Metview's Macro language functions, with automatic translations between data types. Here's an example that shows how to retrieve model and observation data and compute their difference, and the weighted mean value of that difference, both in Macro and in Python.

...

MacroPythonNotes
numbernumber
stringstring
listlistCan also pass a tuple to Macro, and it will be converted to a Macro list
fieldsetFieldsetLightweight wrapper class in Meview-Python
geopointsGeopointsLightweight wrapper class in Meview-Python
observationsBufrLightweight wrapper class in Meview-Python
netcdfNetCDFLightweight wrapper class in Meview-Python
odbOdbLightweight wrapper class in Meview-Python
tableTableLightweight wrapper class in Meview-Python
vectornumPy array
datedatetimeCan also pass a date or a datetime64 to Macro
definitiondictionary
nilNone

Additional data export features

NumPy arrays


Working with Fieldsets

Fieldsets work much the same as they do in the Macro language, but watch out for these things:

  • length of a fieldset can be found with the len function: num_fields = len(my_fieldset)
  • indexing starts at 0: first_field = my_fieldset[0]
  • slicing works: my_fields = fs[0:6:2]
  • you can pass a numpy array of indexes: my_fields = fs[np.array([1.0, 2.0, 0.0, 5.0])]
  • comparison operators work the same as in Macro, i.e. they return a fieldset of 1s and 0s: smaller = fs1 < fs2
  • equality and non-equality operators are == and !=
  • Fieldsets can be directly constructed either as empty, or with a path to a GRIB file:
    • f = mv.Fieldset()
    • f = mv.Fieldset(path='test.grib')
  • concatenation can be done like this:  my_fieldset.append(my_other_fieldset)
  • iteration works: for f in my_fieldset:  #do something

Working with Geopoints

Geopoints also work much the same as they do in Macro, but be aware of these points:

  • in Macro, we use geo_missing_value to denote missing data values; in Python, we use numpy.nan

Working with dates

There are several differences between the usage of the date object in Macro and the datetime object in Python. You will find a few examples below to compare the various date manipulation techniques used in Macro and Python, respectively.

MacroPython


Code Block
languagepy
# Metview Macro



# creating
d = 2000-01-04 09:50:24 
today = date(0)
yesterday = date(-1) 

# arithmetic
d = d + hour(9) + minute(50) + second(24) 


# using an increment of 2 days
for d = 2018-11-01 to 2018-11-10 by 2 do
  (...)
end for 
 



# using an increment of 6 hours
for d = 2018-11-01 to 2018-11-10 by hour(6) do
   x = retrieve(
      date : yymmdd(d),
      time : hhmm(d),
      ...)
   (...)
end for



Code Block
languagepy
import metview as mv
import numpy as np
from datetime import datetime, timedelta

# creating 
d = datetime(2000, 1, 4, 9, 50, 24)
today = datetime.today()
yesterday = datetime.today() - timedelta(1) 

# arithmetic
d = d + timedelta(hours=9, minutes=50, seconds=24) 


# using an increment of 2 days
d0 = datetime(2018,11,1)
d1 = datetime(2018,11,10)
dt = timedelta(days = 2)
for d in np.arange(d0, d1, dt):
    (...)


# using an increment of 6 hours
d0 = datetime(2018, 11, 1)
d1 = datetime(2018, 11, 10)
dt = timedelta(hours = 6)
for d = np.arange(d0, d1, dt):
	x = mv.retrieve(date =d, 
			time = mv.hour(d), ...)	
	(...)	


Additional data export features

NumPy arrays

Any Metview function that normally returns a vector Any Metview function that normally returns a vector will return a numPy array when called from Python. dtypes of float32 and float64 are supported. For example, the follownig following fieldset functions return numPy arrays:

...