Magics


NameMagics JSON
Version 1.5.8 PyPI version JSON
download
home_pagehttps://github.com/ecmwf/magics-python
SummaryPython interface to plot meteorological data in GRIB, NetCDF and BUFR.
upload_time2022-04-13 14:19:33
maintainer
docs_urlNone
authorEuropean Centre for Medium-Range Weather Forecasts (ECMWF)
requires_python
licenseApache License Version 2.0
keywords magics visualisation meteorology grib netcdf bufr
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
Magics is the latest generation of the ECMWF's meteorological plotting software and can be either
accessed directly through its Python or Fortran interfaces or by using Metview.


Features:

- supports plotting of contours, wind fields, observations, satellite images, symbols, text, axis and graphs (including boxplots)
- can plot GRIB 1 and 2 coded data, gaussian grid, regularly spaced grid and fitted data

Limitations:

- development stage: **Alpha**,


Installation
------------

The package is installed from PyPI with::

    $ pip install Magics


System dependencies
~~~~~~~~~~~~~~~~~~~

The python module depends on the ECMWF *Magics* and *eccodes* libraries

They can be installed from PyPI with::
     $ pip install ecmwflibs



You may run a simple selfcheck command to ensure that your system is set up correctly::

    $ python -m Magics selfcheck
    Found: Magics 'Magics 4.10.0'.
    Library: /usr/local/lib/python3.9/site-packages/ecmwflibs/.dylibs/libMagPlus.dylib
    Magics home: /usr/local/lib/python3.9/site-packages/ecmwflibs
    Your system is ready.


Usage
-----

First, you need a well-formed GRIB file, if you don't have one at hand you can download our
a 2m temperature grib file::

    $ wget http://download.ecmwf.int/test-data/magics/2m_temperature.grib


You may try out the high level API in a python interpreter::



   from Magics import macro as magics

   name = 'magics'
   #Setting of the output file name
   output = magics.output(output_formats = ['png'],
    		output_name_first_page_number = "off",
    		output_name = "magics")

   #Import the  data
   data =  magics.mgrib(grib_input_file_name  = "2m_temperature.grib", )

   #Apply an automatic styling
   contour = magics.mcont( contour_automatic_setting = "ecmwf", )
   coast = magics.mcoast()
   magics.plot(output, data, contour, coast)


Running the test program will create a png named magics.png


You can find notebooks examples :
https://github.com/ecmwf/notebook-examples/tree/master/visualisation

Contributing
------------

The main repository is hosted on GitHub,
testing, bug reports and contributions are highly welcomed and appreciated:

https://github.com/ecmwf/magics-python

Please see the CONTRIBUTING.rst document for the best way to help.

Lead developer:

- `Sylvie Lamy-Thepaut <https://github.com/sylvielamythepaut>`_ - ECMWF

Main contributors:

- `Stephan Siemen <https://github.com/stephansiemen>`_ - ECMWF
- `Alessandro Amici <https://github.com/alexamici>`_ - B-Open
- `Daniel Tipping <https://github.com/dtip>`_ - `Old Reliable <https://oldreliable.tech>`_
- `Ian Vermes <https://github.com/IanVermes>`_ - `Old Reliable <https://oldreliable.tech>`_

License
-------

Copyright 2017-2018 European Centre for Medium-Range Weather Forecasts (ECMWF).

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: 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.

.. |Travis Build| image:: https://img.shields.io/travis/ecmwf/magics-python/master.svg?logo=travis
   :target: https://travis-ci.org/ecmwf/magics-python/branches
.. |Appveyor Build| image:: https://img.shields.io/appveyor/ci/ecmwf/magics-python/master.svg?logo=appveyor
   :target: https://ci.appveyor.com/project/ecmwf/magics-python/branch/master
.. |ReadTheDocs Build| image:: https://readthedocs.org/projects/magics-python/badge/?version=latest
    :target: https://magics-python.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ecmwf/magics-python",
    "name": "Magics",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "magics visualisation meteorology grib netcdf bufr",
    "author": "European Centre for Medium-Range Weather Forecasts (ECMWF)",
    "author_email": "software.support@ecmwf.int",
    "download_url": "https://files.pythonhosted.org/packages/94/f8/7247ee384c0044c4d9d950a3d2ea1003dca89c626eaf4a90ce0eb3a02d99/Magics-1.5.8.tar.gz",
    "platform": null,
    "description": "\nMagics is the latest generation of the ECMWF's meteorological plotting software and can be either\naccessed directly through its Python or Fortran interfaces or by using Metview.\n\n\nFeatures:\n\n- supports plotting of contours, wind fields, observations, satellite images, symbols, text, axis and graphs (including boxplots)\n- can plot GRIB 1 and 2 coded data, gaussian grid, regularly spaced grid and fitted data\n\nLimitations:\n\n- development stage: **Alpha**,\n\n\nInstallation\n------------\n\nThe package is installed from PyPI with::\n\n    $ pip install Magics\n\n\nSystem dependencies\n~~~~~~~~~~~~~~~~~~~\n\nThe python module depends on the ECMWF *Magics* and *eccodes* libraries\n\nThey can be installed from PyPI with::\n     $ pip install ecmwflibs\n\n\n\nYou may run a simple selfcheck command to ensure that your system is set up correctly::\n\n    $ python -m Magics selfcheck\n    Found: Magics 'Magics 4.10.0'.\n    Library: /usr/local/lib/python3.9/site-packages/ecmwflibs/.dylibs/libMagPlus.dylib\n    Magics home: /usr/local/lib/python3.9/site-packages/ecmwflibs\n    Your system is ready.\n\n\nUsage\n-----\n\nFirst, you need a well-formed GRIB file, if you don't have one at hand you can download our\na 2m temperature grib file::\n\n    $ wget http://download.ecmwf.int/test-data/magics/2m_temperature.grib\n\n\nYou may try out the high level API in a python interpreter::\n\n\n\n   from Magics import macro as magics\n\n   name = 'magics'\n   #Setting of the output file name\n   output = magics.output(output_formats = ['png'],\n    \t\toutput_name_first_page_number = \"off\",\n    \t\toutput_name = \"magics\")\n\n   #Import the  data\n   data =  magics.mgrib(grib_input_file_name  = \"2m_temperature.grib\", )\n\n   #Apply an automatic styling\n   contour = magics.mcont( contour_automatic_setting = \"ecmwf\", )\n   coast = magics.mcoast()\n   magics.plot(output, data, contour, coast)\n\n\nRunning the test program will create a png named magics.png\n\n\nYou can find notebooks examples :\nhttps://github.com/ecmwf/notebook-examples/tree/master/visualisation\n\nContributing\n------------\n\nThe main repository is hosted on GitHub,\ntesting, bug reports and contributions are highly welcomed and appreciated:\n\nhttps://github.com/ecmwf/magics-python\n\nPlease see the CONTRIBUTING.rst document for the best way to help.\n\nLead developer:\n\n- `Sylvie Lamy-Thepaut <https://github.com/sylvielamythepaut>`_ - ECMWF\n\nMain contributors:\n\n- `Stephan Siemen <https://github.com/stephansiemen>`_ - ECMWF\n- `Alessandro Amici <https://github.com/alexamici>`_ - B-Open\n- `Daniel Tipping <https://github.com/dtip>`_ - `Old Reliable <https://oldreliable.tech>`_\n- `Ian Vermes <https://github.com/IanVermes>`_ - `Old Reliable <https://oldreliable.tech>`_\n\nLicense\n-------\n\nCopyright 2017-2018 European Centre for Medium-Range Weather Forecasts (ECMWF).\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0.\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n.. |Travis Build| image:: https://img.shields.io/travis/ecmwf/magics-python/master.svg?logo=travis\n   :target: https://travis-ci.org/ecmwf/magics-python/branches\n.. |Appveyor Build| image:: https://img.shields.io/appveyor/ci/ecmwf/magics-python/master.svg?logo=appveyor\n   :target: https://ci.appveyor.com/project/ecmwf/magics-python/branch/master\n.. |ReadTheDocs Build| image:: https://readthedocs.org/projects/magics-python/badge/?version=latest\n    :target: https://magics-python.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\n\n",
    "bugtrack_url": null,
    "license": "Apache License Version 2.0",
    "summary": "Python interface to plot meteorological data in GRIB, NetCDF and BUFR.",
    "version": "1.5.8",
    "project_urls": {
        "Homepage": "https://github.com/ecmwf/magics-python"
    },
    "split_keywords": [
        "magics",
        "visualisation",
        "meteorology",
        "grib",
        "netcdf",
        "bufr"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "94f87247ee384c0044c4d9d950a3d2ea1003dca89c626eaf4a90ce0eb3a02d99",
                "md5": "31b8c6da20156f88d14253fc089175f7",
                "sha256": "7df4241802fb552ee052da18190a5266a8faff7feecc70779cb5e1809625fb90"
            },
            "downloads": -1,
            "filename": "Magics-1.5.8.tar.gz",
            "has_sig": false,
            "md5_digest": "31b8c6da20156f88d14253fc089175f7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 22594,
            "upload_time": "2022-04-13T14:19:33",
            "upload_time_iso_8601": "2022-04-13T14:19:33.093669Z",
            "url": "https://files.pythonhosted.org/packages/94/f8/7247ee384c0044c4d9d950a3d2ea1003dca89c626eaf4a90ce0eb3a02d99/Magics-1.5.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-04-13 14:19:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ecmwf",
    "github_project": "magics-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "magics"
}
        
Elapsed time: 0.46520s