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.
Macro | Python | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
You can see that the Macro functions are all available through the namespace defined in the import
command.
More examples are available in the Python the Gallery (Redundant).
Variable types
When calling Macro functions from Python, variables passed as input to or output from those functions undergo a conversion as described in this table:
Macro | Python | Notes |
---|---|---|
number | number | |
string | string | |
list | list | Can also pass a tuple to Macro, and it will be converted to a Macro list |
fieldset | Fieldset | Lightweight wrapper class in Meview-Python |
geopoints | Geopoints | Lightweight wrapper class in Meview-Python |
observations | Bufr | Lightweight wrapper class in Meview-Python |
netcdf | NetCDF | Lightweight wrapper class in Meview-Python |
odb | Odb | Lightweight wrapper class in Meview-Python |
table | Table | Lightweight wrapper class in Meview-Python |
vector | numPy array | |
date | datetime | Can also pass a date or a datetime64 to Macro |
definition | dictionary | |
nil | None |
Additional data export features
...
Macro functions which correspond to icons, such as retrieve()
, which corresponds to the Mars Retrieval icon, can take their arguments in a number of ways:
Method | Example |
---|---|
Named arguments | a = mv.retrieve(type = 'fc', date = -5) |
Dictionary |
|
Combination |
|
Object-oriented calling
Metview's Python interface also provides a more object-oriented way of using the wrapper classes such as Fieldset. The following two snippets of code are equivalent:
Function | Object method |
---|---|
|
|
Calling user-defined Macro functions from Python
...
- Macro indexing starts at 1, but Python indexing starts at 0. Aside from the standard Python structures such as lists, this is also true for Metview Python classes such as Fieldset. Given a fieldset
fs
, the first field is obtained in Macro byfs[1]
, but in Python it is obtained byfs[0]
. - In order to support the more interactive coding environments provided by Python, any call to the
plot()
command will immediately produce a plot. This is different from Macro, where plots are delayed until the end. The result of this is that multipleplot()
commands in Python will result in multiple plot windows. Fortunately, a singleplot()
command can be given any number of items, including multiple pages. To see how to produce a multi-plot layout, please see the Layoutx3 In Python gallery Example gallery example.