forked from MHKiT-Software/MHKiT-Python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md
34 lines (28 loc) · 1.62 KB
/
README.md
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
31
32
33
34
 MHKiT-Python
=====================================
[](https://travis-ci.org/MHKiT-Software/MHKiT-Python)
[](https://coveralls.io/github/MHKiT-Software/MHKiT-Python?branch=master)
[](https://pepy.tech/project/mhkit)
MHKiT-Python is a Python package designed for marine renewable energy applications to assist in
data processing and visualization. The software package include functionality for:
* Data processing
* Data visualization
* Data quality control
* Resource assessment
* Device performance
* Device loads
Documentation
------------------
MHKiT-Python documentation includes overview information, installation instructions, API documentation, and examples.
See the [MHKiT documentation](https://mhkit-software.github.io/MHKiT) for more information.
Installation
------------------------
MHKiT-Python requires Python (3.6 or 3.7) along with several Python
package dependencies. MHKiT-Python can be installed from PyPI using the command ``pip install mhkit``.
See [installation instructions](https://mhkit-software.github.io/MHKiT/installation.html) for more information.
Copyright and license
------------------------
MHKiT-Python is copyright through the National Renewable Energy Laboratory,
Pacific Northwest National Laboratory, and Sandia National Laboratories.
The software is distributed under the Revised BSD License.
See [copyright and license](LICENSE.md) for more information.