Metadata-Version: 2.1
Name: kyoslib_py
Version: 5.2.1
Summary: KYOS shared lib code as python package
Home-page: http://github.com/kyosenergy/kyoslib_py
License: MIT
Author: KYOS
Author-email: support@kyos.com
Requires-Python: >=3.11,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: h5py (>=3.9.0,<4.0.0)
Requires-Dist: mkdocstrings-python (>=1.7.0,<2.0.0)
Requires-Dist: numba (>=0.57.1,<0.60.0)
Requires-Dist: numpy (>=1.24.4,<2.0.0)
Requires-Dist: pandas (<2.0.0)
Requires-Dist: plotly (>=5.16.1,<6.0.0)
Requires-Dist: postmarker (>=1.0,<2.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Project-URL: Documentation, https://kyosenergy.github.io/kyoslib_py/
Project-URL: Repository, http://github.com/kyosenergy/kyoslib_py
Description-Content-Type: text/markdown

# kyoslib_py

## Usage

Example code:

```python
from kyoslib_py.simulation import Simulation
simulation_set = Simulation()
```

## Installation

```pip install kyoslib_py```

## Dependencies

Python 3.11+

## Development

This project is executing CI checks using **GitHub actions**.

It will run `pytest` and `black`.

### Invoking development tasks

[Invoke](https://www.pyinvoke.org/) is used for development tasks.

Tasks are stored in `tasks.py` and are executable using the `inv[oke]` command line tool.

To see the list of tasks, you can type:

```bash
inv --list
```

For example, before your commits, you should run
```bash
inv format
```
to format your code.

## Documentation

The package documentation is generated by MkDocs. The correct version can be installed in the project's virtual environment by:

```bash
poetry install
```

Then the documentation can be built, and a server to view it started by:

```bash
mkdocs serve
```

