Metadata-Version: 2.4
Name: baec
Version: 0.2.2
Summary: Python SDK to create Model Generators and add them into the BAEC platform.
License: MIT License
        
        Copyright (c) 2024 CEMS
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: repository, https://github.com/cemsbv/BAEC
Keywords: API,BAEC,CEMS,CRUX
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<3,>2
Requires-Dist: pandas<3,>2
Requires-Dist: cems-nuclei[client]<4,>=0.5
Requires-Dist: matplotlib<4,>=3.8
Requires-Dist: tqdm[notebook]<5,>4
Requires-Dist: pyproj<4,>3
Provides-Extra: test
Requires-Dist: coveralls; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: requests-mock; extra == "test"
Provides-Extra: docs
Requires-Dist: Sphinx==6.1.3; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints==1.22; extra == "docs"
Requires-Dist: ipython==8.11.0; extra == "docs"
Requires-Dist: asteroid-sphinx-theme==0.0.3; extra == "docs"
Requires-Dist: sphinx_rtd_theme<2,>1.2; extra == "docs"
Requires-Dist: enum-tools[sphinx]<0.14,>=0.13; extra == "docs"
Provides-Extra: aws
Requires-Dist: boto3<2,>1.34; extra == "aws"
Provides-Extra: gui
Requires-Dist: marimo[recommended]<0.15,>0.14; extra == "gui"
Requires-Dist: micropip<0.11,>0.10; extra == "gui"
Dynamic: license-file

# BAEC Model Generator SDK

Python SDK to create Model Generators and add them into the BAEC platform.

[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![Coverage Status](https://coveralls.io/repos/github/cemsbv/BAEC/badge.svg?branch=main)](https://coveralls.io/github/cemsbv/BAEC?branch=main)

This repository is created by [CEMS BV](https://cemsbv.nl/).

# Installation

To install a package in this repository run:

`$ pip install baec`

## ENV VARS

To use `baec` with `FitCore` to fit and predict settlements, add the follow ENV vars to your environment. Or provide them when asked.

```
* NUCLEI_TOKEN
    - Your NUCLEI user token
```

You can obtain your `NUCLEI_TOKEN` on [NUCLEI](https://nuclei.cemsbv.io/#/).
Go to `personal-access-tokens` and create a new user token.

## GUI

```bash
set -a; source ./*.env; set +a
marimo edit ./notebooks/gui_notebook.py
#marimo run ./notebooks/gui_notebook.py
#marimo export html-wasm ./notebooks/gui_notebook.py -o build/marimo --mode run
```

# Contribution

## Environment

We recommend developing in Python 3.12 with a clean virtual environment (using `virtualenv` or `conda`), installing the requirements from the requirements.txt file:

Example using `virtualenv` and `pip` to install the dependencies in a new environment .env on Linux:

```bash
python -m venv .env
source .env/bin/activate
python -m pip install --upgrade pip setuptools
uv pip install -r requirements.txt
uv pip install -e .
```

## Documentation

Build the docs:

```bash
python -m pip install --upgrade pip setuptools
uv pip install -r requirements.txt
uv pip install .

sphinx-build -b html docs public
```

## Format

We format our code with black and isort.

```bash
black --config "pyproject.toml" src/baec tests example
isort --settings-path "pyproject.toml" src/baec tests example
```

## Lint

To maintain code quality we use the GitHub super-linter.

To run the linters locally, run the `run_super_linters.sh` bash script from the root directory.

## UnitTest

Test the software with the use of coverage:

```bash
set -a; source ./*.env; set +a
python -m pip install --upgrade pip setuptools
uv pip install -r requirements.txt
uv pip install -e .
coverage run -m pytest
```

## Requirements

Requirements are autogenerated by the `uv` command with python 3.13

Install uv with:

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

Generate requirements.txt file with:

```bash
uv pip compile --python-version 3.13 --extra=test --extra=docs --extra=aws --extra=gui --output-file=requirements.txt pyproject.toml
```

Update the requirements within the defined ranges with:

```bash
uv pip compile --python-version 3.13 --upgrade --extra=test --extra=docs --extra=aws --extra=gui --output-file=requirements.txt pyproject.toml
```
