# cwru

**Repository Path**: wsyybt/cwru

## Basic Information

- **Project Name**: cwru
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-13
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Case Western Reserve University Bearing Data
============================================

Usage
-----

.. code-block:: python

  import cwru
  data = cwru.CWRU("12DriveEndFault", "1797", 384)

Then, you can use ``data.X_train``, ``data.y_train``, ``data.X_test``, ``data.y_test``, ``data.labels``, ``data.nclasses`` to train and evaluate your data driven fault diagnostic algrithms.

Not have a local copy of CWRU Bearing data on your machine? Don't be worry, These ``.mat`` files required by your code will be automatically downloaded from `Case Western Reserve University Bearing Data Center`_, renamed properly with their corresponding class, stored in ``~/Datasets/CWRU`` directory to avoid downloading in future.

Arguments
---------

The constructor of class ``cwru.CWRU`` has three arguments:

* **exp**: experiment, supporting ``"12DriveEndFault", "12FanEndFault", "48DriveEndFault"``
* **rpm**: rpm during testing
* **length**: length of the signal slice, namely ``X_train.shape[1]``

Install
-------

Install by pip:

  $ pip install --user cwru

Or install manually:

  $ python setup.py install

Test
----

You can run unit test by:

  $ python -m unittest discover

.. _Case Western Reserve University Bearing Data Center: http://csegroups.case.edu/bearingdatacenter/pages/download-data-file