openstef 3.4.56__py3-none-any.whl → 4.0.0a3__py3-none-any.whl

openstef-4.0.0a3.dist-info/METADATA

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: openstef
+Version: 4.0.0a3
+Summary: Open Short Term Energy forecasting library
+Project-URL: Documentation, https://openstef.github.io/openstef/index.html
+Project-URL: Homepage, https://lfenergy.org/projects/openstef/
+Project-URL: Issues, https://github.com/OpenSTEF/openstef/issues
+Project-URL: Repository, https://github.com/OpenSTEF/openstef
+Author-email: "Alliander N.V" <openstef@lfenergy.org>
+License-Expression: MPL-2.0
+License-File: LICENSE.md
+Keywords: energy,forecasting,machinelearning
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: <4.0,>=3.12
+Requires-Dist: openstef-core==4.0.0a3
+Requires-Dist: openstef-models[xgb-cpu]==4.0.0a3
+Provides-Extra: all
+Requires-Dist: openstef-beam[all]==4.0.0a3; extra == 'all'
+Requires-Dist: openstef-core==4.0.0a3; extra == 'all'
+Requires-Dist: openstef-models[xgb-cpu]==4.0.0a3; extra == 'all'
+Provides-Extra: beam
+Requires-Dist: huggingface-hub>=0.35.3; extra == 'beam'
+Requires-Dist: openstef-beam==4.0.0a3; extra == 'beam'
+Provides-Extra: core
+Requires-Dist: openstef-core==4.0.0a3; extra == 'core'
+Provides-Extra: models
+Requires-Dist: openstef-models[xgb-cpu]==4.0.0a3; extra == 'models'
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+
+SPDX-License-Identifier: MPL-2.0
+-->
+
+# OpenSTEF
+
+<!-- Badges -->
+
+[![Downloads](https://static.pepy.tech/badge/openstef)](https://pepy.tech/project/openstef)
+[![Downloads](https://static.pepy.tech/badge/openstef/month)](https://pepy.tech/project/openstef)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5585/badge)](https://bestpractices.coreinfrastructure.org/projects/5585)
+
+**OpenSTEF** is a modular library for creating short-term forecasts in the energy sector. Version 4.0 introduces a complete architectural refactor with enhanced modularity, type safety, and modern Python development practices.
+
+## What's New in 4.0
+
+- **Modular Architecture**: Install only the components you need
+- **Modern Tooling**: Built with uv, ruff, pyright, and poe for optimal developer experience
+- **Full Type Safety**: Comprehensive type hints throughout the codebase
+- **Monorepo Structure**: Unified development with specialized packages
+- **Enhanced Workflows**: Streamlined development and contribution processes
+
+## Table of Contents
+
+- [OpenSTEF](#openstef)
+  - [What's New in 4.0](#whats-new-in-40)
+  - [Table of Contents](#table-of-contents)
+  - [Quick Start](#quick-start)
+  - [Package Architecture](#package-architecture)
+  - [Installation](#installation)
+    - [Requirements](#requirements)
+    - [Basic Installation](#basic-installation)
+    - [Modern Package Managers](#modern-package-managers)
+  - [Documentation](#documentation)
+  - [Contributing](#contributing)
+    - [Quick Development Setup](#quick-development-setup)
+  - [License](#license)
+  - [Contact \& Support](#contact--support)
+
+## Quick Start
+
+```bash
+# Install OpenSTEF
+pip install openstef
+
+# Start forecasting
+python -c "import openstef_models; print('OpenSTEF 4.0 ready!')"
+```
+
+**[Get started with our Quick Start Guide](https://openstef.github.io/openstef/v4/user_guide/quick_start.html)** - step-by-step tutorial with real examples.
+
+## Package Architecture
+
+OpenSTEF 4.0 uses a modular design with specialized packages:
+
+| Package | Purpose | Install Command |
+|---------|---------|-----------------|
+| **openstef** | Meta-package with core components | `pip install openstef` |
+| **openstef-models** | ML models, feature engineering, data processing | `pip install openstef-models` |
+| **openstef-beam** | Backtesting, Evaluation, Analysis, Metrics | `pip install openstef-beam` |
+| **openstef-core** | Core utilities, dataset types, shared types and base models used by other packages | `pip install openstef-core` |
+| **openstef-compatibility** | OpenSTEF 3.x compatibility layer | Coming soon |
+| **openstef-foundational-models** | Deep learning and foundational models | Coming soon |
+
+**[Learn more about the architecture](https://openstef.github.io/openstef/v4/user_guide/installation.html#package-architecture)** in our documentation.
+
+## Installation
+
+### Requirements
+- **Python 3.12+** (Python 3.13 supported)
+- **64-bit operating system** (Windows, macOS, Linux)
+
+### Basic Installation
+
+```bash
+# For most users
+pip install openstef
+
+# Core forecasting only
+pip install openstef-models
+
+# With all optional tools
+pip install "openstef[all]"
+```
+
+### Modern Package Managers
+
+```bash
+# Using uv (recommended for development)
+uv add openstef
+
+# Using conda
+conda install -c conda-forge openstef
+```
+
+**[Complete Installation Guide](https://openstef.github.io/openstef/v4/user_guide/installation.html)** - detailed instructions including troubleshooting for Apple Silicon, GPU support, and development setup.
+
+## Documentation
+
+- **[Main Documentation](https://openstef.github.io/openstef/v4/)** - guides and API reference
+- **[Quick Start Guide](https://openstef.github.io/openstef/v4/user_guide/quick_start.html)** - get up and running fast
+- **[Tutorials](https://openstef.github.io/openstef/v4/user_guide/tutorials.html)** - step-by-step examples
+- **[API Reference](https://openstef.github.io/openstef/v4/api/)** - detailed function documentation
+- **[Contributing Guide](https://openstef.github.io/openstef/v4/contribute/)** - how to contribute to OpenSTEF
+
+## Contributing
+
+We welcome contributions to OpenSTEF 4.0! 
+
+**[Read our Contributing Guide](https://openstef.github.io/openstef/v4/contribute/)** - documentation for contributors including:
+
+- How to report bugs and suggest features
+- Documentation improvements and examples
+- Code contributions and development setup
+- Sharing datasets and real-world use cases
+
+### Quick Development Setup
+
+```bash
+# Clone and set up for development
+git clone https://github.com/OpenSTEF/openstef.git
+cd openstef
+uv sync --dev
+
+# Run tests and quality checks
+uv run poe all
+```
+
+**Code of Conduct**: We follow the [Contributor Code of Conduct](https://openstef.github.io/openstef/v4/contribute/code_of_conduct.html) to ensure a welcoming environment for all contributors.
+
+## License
+
+**Mozilla Public License Version 2.0** - see [LICENSE.md](LICENSE.md) for details.
+
+This project includes third-party libraries licensed under their respective Open-Source licenses. SPDX-License-Identifier headers show applicable licenses. License files are in the [LICENSES/](LICENSES/) directory.
+
+## Contact & Support
+
+- **[Support Guide](https://openstef.github.io/openstef/v4/project/support.html)** - how to get help
+- **[GitHub Discussions](https://github.com/OpenSTEF/openstef/discussions)** - community Q&A and discussions
+- **[Issue Tracker](https://github.com/OpenSTEF/openstef/issues)** - bug reports and feature requests
+- **[LF Energy OpenSTEF](https://www.lfenergy.org/projects/openstef/)** - project homepage

openstef-4.0.0a3.dist-info/RECORD

@@ -0,0 +1,4 @@
+openstef-4.0.0a3.dist-info/METADATA,sha256=vHUIDLHdsNjjsxc8eA4cIL-f5dhLEsPs0gfnkN0AlnM,7112
+openstef-4.0.0a3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+openstef-4.0.0a3.dist-info/licenses/LICENSE.md,sha256=7Pm2fWFFHHUG5lDHed1vl5CjzxObIXQglnYsEdtjo_k,14907
+openstef-4.0.0a3.dist-info/RECORD,,

{openstef-3.4.56.dist-info → openstef-4.0.0a3.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

openstef/__init__.py

@@ -1,14 +0,0 @@
-# SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
-#
-# SPDX-License-Identifier: MPL-2.0
-
-from importlib.metadata import PackageNotFoundError, version
-from pathlib import Path
-
-PROJECT_ROOT = Path(__file__).parent.parent.absolute()
-
-try:
-    __version__ = version("openstef")
-except PackageNotFoundError:
-    # package is not installed
-    pass

openstef/__main__.py

@@ -1,3 +0,0 @@
-# SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
-#
-# SPDX-License-Identifier: MPL-2.0

openstef/app_settings.py

@@ -1,19 +0,0 @@
-# SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
-#
-# SPDX-License-Identifier: MPL-2.0
-
-from pydantic import Field
-from pydantic_settings import BaseSettings, SettingsConfigDict
-
-
-class AppSettings(BaseSettings):
-    """Global app settings."""
-
-    model_config = SettingsConfigDict(
-        env_prefix="openstef_", env_file=".env", extra="ignore"
-    )
-
-    post_teams_messages: bool = True
-
-    # Logging settings.
-    log_level: str = Field("INFO", description="Log level used for logging statements.")