Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

ipython extension for pyferret

Project description

ipython_ferretmagic

IPython notebook extension for ferret (a great software for Data Visualisation and Analysis from NOAA/PMEL).

Browse the demo notebooks from http://nbviewer.ipython.org/github/PBrockmann/ipython_ferretmagic/tree/master/notebooks

Combine ferret and ipython widgets and create interactive notebooks !

Test it with binder. Binder

Browse a basic ferret tutorial using ferretmagic from: https://github.com/PBrockmann/C-CASCADES_notebooks/blob/master/ferretBasics.ipynb

ScreenShot

Latest news

2018/10/01

  • Compatibility with python 3 with print command and base64 encoding
  • Tested with pyferret==7.43, notebook==5.7.0, jupyter==1.0.0, ipython==5.8.0, ipywidgets==7.4.2
  • Update pip package (now last version is 20181001 https://pypi.org/project/ferretmagic/)

2018/01/18

2017/03/17

  • Tested with pyferret==7.1, jupyter==4.2.0, ipywidgets==6.0.0

2016/10/28

  • Tested with pyferret==7.0, jupyter==4.2.0 and ipython==5.1.0
  • Installation from pip

Installation

Install PyFerret following instructions from http://ferret.pmel.noaa.gov/Ferret/documentation/pyferret It will set all directories needed to run pyferret (font, ppl, jnls, datasets, ...).

You can also install PyFerret as a conda package from https://anaconda.org/conda-forge/pyferret (no datasets distributed).

Then install the ferret magic extension (ferretmagic.py) by typing pip install ferretmagic

Usage

In a Jupyter notebook with kernel python (previously named ipython), load the magics:

In [2]: %load_ext ferretmagic

Line magics

The %ferret_run magic enables one-line execution of ferret command in the IPython interpreter or notebook:

    In [3]: for i in [100,500,1000]:
      ....: 	%ferret_run -s 400,400 'plot sin(i[i=1:%(i)s]*0.1)' % locals()

Cell magics

Multi-line input can be entered with the %%ferret cell magic:

In [4]: %%ferret
  ....: use levitus_climatology
  ....: shade temp[k=1]			! comments
  • Control size of plot with --size, -s option.
  • Create a local pdf at the same time with --pdf, -p option.
In [5]: %%ferret -s 400,300 -pdf myfig.pdf
  ....: shade temp[k=1]			

Passing variables between Python and ferret

  • Variables can be pushed from IPython into ferret with %ferret_putdata:
In [18]: %%ferret
   ....: use levitus_climatology
In [19]: %ferret_getdata tempdict = temp
   ....: Message: tempdict is now available in python as a dictionary containing the variable's metadata and data array.
In [20]: print tempdict.keys()
   ....: ['axis_coords', 'axis_types', 'data_unit', 'axis_units', 'title', 'axis_names', 'missing_value', 'data']
  • Variables can be pulled from ferret into IPython with %ferret_getdata:
In [31]: import numpy as np
   ....: b = {}
   ....: b['name']='myvar'
   ....: b['name']='myvar'
   ....: x=np.linspace(-np.pi*4, np.pi*4, 500)
   ....: b['data']=np.sin(x)/x
   ....: b.keys()
Out[31]: ['data', 'name']
In [32]: %ferret_putdata --axis_pos (1,0,2,3,4,5) b
   ....: Message: b is now available in ferret as myvar

Explore notebook for examples.

Known issues and limitations

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ferretmagic, version 20181001
Filename, size File type Python version Upload date Hashes
Filename, size ferretmagic-20181001-py2-none-any.whl (8.1 kB) File type Wheel Python version py2 Upload date Hashes View hashes
Filename, size ferretmagic-20181001-py3-none-any.whl (9.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size ferretmagic-20181001.tar.gz (7.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page