<commit_before>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/

## Latest commit

Combine pyferret and ipython widgets

![ScreenShot](ferretmagic_widgets.png)

## Installation

Install pyferret following instructions from http://ferret.pmel.noaa.gov/Ferret/documentation/pyferret.

Once you can import the pyferret module in python then install the ipython notebook extension.

In IPython, install ferretmagic:

    In [1]: %install_ext https://raw.github.com/PBrockmann/ipython-ferretmagic/master/ferretmagic.py

Tested with pyferret 1.0.2 and IPython 1.2.0, 1.2.1, 2.1.0, 2.3.0
    
## Usage

In IPython, load the magics:

    In [2]: %reload_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()
```
<commit_msg>Changed README<commit_after>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/

## Latest news 

Combine pyferret and ipython widgets and create interactive notebooks !

![ScreenShot](ferretmagic_widgets.png)

## Installation

Install pyferret following instructions from http://ferret.pmel.noaa.gov/Ferret/documentation/pyferret.

Once you can import the pyferret module in ipython then install the ipython notebook extension.

In IPython, install ferretmagic:

    In [1]: %install_ext https://raw.github.com/PBrockmann/ipython-ferretmagic/master/ferretmagic.py

Tested with pyferret 1.0.2 and IPython 1.2.0, 1.2.1, 2.1.0, 2.3.0
    
## Usage

In IPython, load the magics:

    In [2]: %reload_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()
```

{'fraction_non_alphanumeric': 0.125, 'fraction_numerical': 0.03200692041522491, 'mean_word_length': 4.329493087557604, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6010250', 'n_tokens_mistral': 864, 'n_tokens_neox': 792, 'n_words': 223}