# otp.Source.script

#### Source.script(func, inplace=False)

Implements a script for every tick.

Allows to pass a `func` that will be applied per every tick.
A `func` can be python callable in this case it will be translated to per tick script.
In order to use it in Remote OTP with Ray, the function should be decorated with `@otp.remote`,
see [Ray usage examples](../../static/ray/ray_examples.md#apply-remote-context) for details.

See [Per Tick Script Guide](../../static/concepts/python_callable_parser.md#python-callable-parser) for more detailed description
of python to OneTick code translation and per-tick script features.

The script written in per tick script language can be passed itself as a string or path to a file with the code.
onetick-py doesn't validate the script, but configure the schema accordingly.

* **Parameters:**
  * **func** (*callable* *,* [*str*](https://docs.python.org/3/library/stdtypes.html#str) *or* *path*) -- 
    - a callable that takes only one parameter - actual tick that behaves like a Source instance
    - or the script on per-tick script language
    - or a path to file with onetick script
  * **self** ([*Source*](root.md#onetick.py.Source))
* **Return type:**
  [`Source`](root.md#onetick.py.Source)

### Examples

```pycon
>>> t = otp.Ticks({'X': [1, 2, 3], 'Y': [4, 5, 6]})
>>> def fun(tick):
...     tick['Z'] = 0
...     if tick['X'] + tick['Y'] == 5:
...         tick['Z'] = 1
...     elif tick['X'] + tick['Y'] * 2 == 15:
...         tick['Z'] = 2
>>> t = t.script(fun)
>>> otp.run(t)
                     Time  X  Y  Z
0 2003-12-01 00:00:00.000  1  4  1
1 2003-12-01 00:00:00.001  2  5  0
2 2003-12-01 00:00:00.002  3  6  2
```

#### SEE ALSO
[`onetick.py.Source.apply()`](apply.md#onetick.py.Source.apply)
[Per-Tick Script Guide](../../static/concepts/python_callable_parser.md#python-callable-parser)