Skip to main content

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

2022/08/25

  • Fix to run with ipykernel 6.15.1

2020/06/03

2019/11/13

  • Tested with python 3.7, pyferret 7.5.0
  • Notebooks run with mybinder.org with 2 files (environment.yml and postBuild)

2018/12/10

  • Tested with pyferret==7.44

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


Download files

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

Source Distribution

ferretmagic-20220825.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

ferretmagic-20220825-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file ferretmagic-20220825.tar.gz.

File metadata

  • Download URL: ferretmagic-20220825.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for ferretmagic-20220825.tar.gz
Algorithm Hash digest
SHA256 f4d55671f25a5e62f7c54f78b2880fcceb9b356b60a5d27057bf9bd22b6aa54b
MD5 18a4653d12e8e441baa2d61322528b06
BLAKE2b-256 2085499dca1fdfd6533ea602042eef38494248d17549d4ffc7973898bdbd4bab

See more details on using hashes here.

File details

Details for the file ferretmagic-20220825-py3-none-any.whl.

File metadata

  • Download URL: ferretmagic-20220825-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for ferretmagic-20220825-py3-none-any.whl
Algorithm Hash digest
SHA256 a1a452246eb40b498dd8568bc9dee82516888e9ed058b4856f8533b14cda4b62
MD5 e08abebf84c0b65f017addd55f271dec
BLAKE2b-256 fe4ed07648bd38e2a53e91a8f4bedb620fcc6a2d42ff960bb3f527d55fd905c3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page