Merge pull request #108 from ronnyhdez/T107

Include metadata for new release

Author: ronnyhdez

CHANGELOG.md

@@ -0,0 +1,75 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.2.0] - 2025-06-25
+
+### Major Updates
+- **Complete documentation overhaul** with modern Sphinx theme
+- **Python version support** expanded to include 3.10, 3.11, 3.12, and 3.13
+- **Dependency modernization** with updated versions of all major dependencies
+
+### Added
+- Documentation with pydata-sphinx-theme
+- Modern badge-based README with clear installation instructions
+- Support for latest Python versions (3.10-3.13)
+- Modern build system using pyproject.toml
+
+### Testing
+- **Migrated test suite to pytest** from unittest for better testing experience
+- Modern test fixtures and parametrized testing
+- Automated testing across multiple Python versions in CI
+
+### Changed
+- **Breaking**: Minimum Python version raised to 3.10
+- Documentation completely rebuilt with modern structure and examples
+- Build system migrated from setup.py to pyproject.toml
+- Updated package structure following modern Python standards
+- Enhanced example data and tutorials
+
+### Updated Dependencies
+- matplotlib >= 3.10.0 (was < 3.0)
+- numpy >= 2.1.3 (major version update)
+- pandas >= 2.2.3 (major version update)
+- scipy >= 1.15.2 (major version update)
+- scikit-learn >= 1.6.1 (major version update)
+- All other dependencies updated to latest stable versions
+
+## [1.1.1] - 2021-11-13
+
+### Previous Release
+- Last stable release before major modernization
+- Support for Python 3.6-3.9
+- Legacy documentation and build system
+- Original CCG geostatistics functionality
+
+---
+
+## Migration Guide
+
+### Upgrading from 1.1.1 to 1.2.1
+
+**Python Version Requirements:**
+- **Minimum Python version is now 3.10** (was 3.6)
+- Ensure you're using Python 3.10 or newer before upgrading
+
+**Installation:**
+```bash
+# Uninstall old version
+pip uninstall pygeostat
+
+# Install new version
+pip install pygeostat
+
+# Verify installation
+python -c "import pygeostat; print(pygeostat.__version__)"
+```
+
+**Code Compatibility:**
+- Most existing code should work without changes
+- Some deprecated matplotlib/pandas patterns may need updating
+- Check the new documentation for updated examples
+

README.md

@@ -5,13 +5,42 @@
   <img alt="Pygeostat Logo" src="http://www.ccgalberta.com/pygeostat/_images/pygeostat_logo.png">
 </picture> 
 
-|||
-| --- | --- |
-| Package | [![CI - Test](https://github.com/CcgAlberta/pygeostat/workflows/IntegrationCheck/badge.svg?branch=master)]( https://github.com/CcgAlberta/pygeostat) [![Docs](https://github.com/CcgAlberta/pygeostat/workflows/Documentation/badge.svg?branch=master)](https://www.ccgalberta.com/pygeostat/welcome.html) [![PyPi](https://badge.fury.io/py/pygeostat.svg)]([https://www.ccgalberta.com/pygeostat/welcome.htm](https://badge.fury.io/py/pygeostat))|
-| Versions | [![Python3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100) [![Python3.11](https://img.shields.io/badge/python-3.11-red.svg)](https://www.python.org/downloads/release/python-3110) |
+[![PyPI](https://badge.fury.io/py/pygeostat.svg)](https://badge.fury.io/py/pygeostat)
+[![Python](https://img.shields.io/pypi/pyversions/pygeostat.svg)](https://pypi.org/project/pygeostat/)
+[![CI](https://github.com/CcgAlberta/pygeostat/workflows/IntegrationCheck/badge.svg?branch=master)](https://github.com/CcgAlberta/pygeostat)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-:warning: This package is being updated. Expect frequent changes to the code and functionality.
-Latest stable release can be found [here](https://github.com/CcgAlberta/pygeostat/releases/tag/v1.1.1)
+:warning: This package has been updated. Expect breaking changes when migrating
+from last stable [version](https://github.com/CcgAlberta/pygeostat/releases/tag/v1.1.1)
+
+## Installation
+
+### Quick Install
+
+```bash
+pip install pygeostat
+```
+
+### Requirements
+- Python 3.10 or higher
+
+### Verify Installation
+
+```{python}
+import pygeostat as gs
+print(f"Pygeostat version: {gs.__version__}")
+print("Basic import successful!")
+```
+
+# Test with example data
+
+```{python}
+# Load example data (this tests data loading functionality)
+data = gs.ExampleData('oilsands')
+print(f"Data loaded: {data.shape}")
+print(f"Columns: {list(data.columns)}")
+print(f"First few rows:\n{data.head()}")
+```
 
 ## Introduction
 
@@ -30,5 +59,9 @@ For a full featured commercial alternative to pygeostat, see [RMSP](https://reso
 
 Contact [Resource Modeling Solutions](https://resourcemodelingsolutions.com/contact/) about a commercial or academic license.
 
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for detailed release notes.
+
 # Contact:
 Refer to [www.ccgalberta.com](http://www.ccgalberta.com).

pyproject.toml

@@ -85,6 +85,20 @@ include = [
     "pygeostat.*",
 ]
 
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-data]
+pygeostat = [
+    "data/**/*"
+]
+
 [tool.setuptools.dynamic]
 version = {attr = "pygeostat.__version__"}
 
+[dependency-groups]
+dev = [
+    "build>=1.2.2.post1",
+    "twine>=6.1.0",
+]
+

src/pygeostat/__init__.py

@@ -10,7 +10,7 @@
 interact with GSLIB and CCG software using Python.
 '''
 
-__version__ = '1.1.1'
+__version__ = '1.2.0'
 
 # parameter configurations
 from . pygeostat_parameters import Parameters, PlotStyle