File: api_documentation.rst

package info (click to toggle)
traittypes 0.2.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 180 kB
  • sloc: python: 516; makefile: 160
file content (30 lines) | stat: -rw-r--r-- 781 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
API Reference Documentation
---------------------------

The ``SciType`` trait type is the base trait type for all Scipy trait types.

It complements the ``traitlets.TraitType`` with a special API to register custom
validators.

.. autoclass:: traittypes.traittypes.SciType
   :members:

The ``Array`` trait type holds a numpy Array.

.. autoclass:: traittypes.traittypes.Array

The ``DataFrame`` trait type holds a pandas DataFrame.

.. autoclass:: traittypes.traittypes.DataFrame

The ``Series`` trait type holds a pandas Series.

.. autoclass:: traittypes.traittypes.Series

The ``Dataset`` trait type holds an xarray Dataset.

.. autoclass:: traittypes.traittypes.Dataset

The ``DataArray`` trait type holds an xarray DataArray.

.. autoclass:: traittypes.traittypes.DataArray