microlens-submit 0.16.2__tar.gz → 0.16.3__tar.gz

microlens_submit-0.16.3/CHANGELOG.md

@@ -0,0 +1,258 @@
+# 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).
+
+## [0.16.3] - 2025-10-28
+
+### Added
+-  Publish to `conda-forge`.
+
+### Fixed
+- Include `pyproject.toml` and other metadata in the sdist so `pip install .` works (fixes conda builds).
+
+## [0.16.2] - 2025-10-28
+
+### Added
+- conda build to release action
+- local `.env` support
+- Zenodo doi automation
+- build wheel and conda build install smoke tests on Mac, Linux, and Windows, python 3.8 and 3.11
+
+
+## [0.16.1] - 2025-10-27
+
+### Added
+- Release automation
+- CI now installs from the wheel across 3.8/3.12 to mirror beta testers’ reports
+
+### Changed
+- `README.md` to clarify Quickstart
+
+### Fixed
+- `importlib_resources` version bug
+
+
+## [0.16.0] - 2024-12-19
+
+### Added
+- **Tier Validation System**: Comprehensive tier-based validation for challenge submissions
+  - New `tier_validation.py` module with support for "standard", "advanced", "test", "2018-test", and "None" tiers
+  - Event ID validation against tier-specific event lists
+  - CLI tier validation with fallback to "None" for invalid tiers
+  - Comprehensive tier validation tests in `tests/test_tier_validation.py`
+- **Enhanced Validation Logic**: Improved parameter validation and solution completeness checking
+  - Enhanced `validate_parameters.py` with better error messages and validation rules
+  - Improved validation for higher-order effects and parameter consistency
+  - Better handling of parameter uncertainties and type validation
+  - Enhanced solution completeness checking with more detailed feedback
+- **Dossier Generation Enhancements**: Improved HTML dossier generation and browser integration
+  - Added model_type display at the top of each solution section in full dossier reports
+  - Added `--open` flag to `microlens-submit generate-dossier` CLI command for automatic browser opening
+  - Added `open: bool = False` parameter to `generate_dashboard_html()` API function
+  - Enhanced dossier navigation and metadata display
+- **Submission Manual Integration**: Converted SUBMISSION_MANUAL.md to reStructuredText format and integrated into Sphinx documentation
+  - Moved submission manual to `docs/submission_manual.rst` for better documentation integration
+  - Updated all internal links and references to point to the new documentation location
+  - Added GitHub link to validate_submission.py script in the submission manual
+  - Removed old markdown file and logo references for cleaner documentation structure
+
+### Changed
+- **Validation System Architecture**: Improved validation workflow and error handling
+  - Enhanced CLI validation commands with better error reporting
+  - Improved validation integration across all CLI commands
+  - Better handling of validation warnings vs errors
+  - Enhanced parameter validation with more detailed feedback
+- **Code Quality & Pre-commit Integration**: Comprehensive code cleanup and formatting improvements
+  - Fixed all pre-commit hook violations including line length, unused imports, and style issues
+  - Resolved f-string formatting issues in CLI commands
+  - Fixed line length violations in dossier generation code
+  - Removed unused imports across the codebase
+  - Ensured all tests pass in both Python 3.8 and 3.11 environments
+- **Documentation Structure**: Improved documentation organization and accessibility
+  - Integrated submission manual into main documentation site
+  - Updated internal documentation links and references
+  - Enhanced documentation consistency and maintainability
+  - Updated API documentation and tutorial examples
+
+### Fixed
+- **Code Quality**: Resolved all pre-commit hook violations
+  - Fixed f-string formatting issues in CLI commands
+  - Resolved line length violations in dossier generation code
+  - Removed unused imports across the codebase
+  - Improved code consistency and maintainability
+- **Validation Logic**: Enhanced parameter validation and error handling
+  - Improved validation for higher-order effects
+  - Better handling of parameter uncertainties
+  - Enhanced solution completeness checking
+  - More detailed validation feedback and error messages
+
+## [0.15.0] - 2024-12-19
+
+### Added
+- New tier validation system with support for "standard", "advanced", "test", "2018-test", and "None" tiers
+- Event ID validation against tier-specific event lists
+- CLI tier validation with fallback to "None" for invalid tiers
+- Comprehensive tier validation tests
+
+### Changed
+- Renamed "basic" tier to "standard" for better naming
+- Updated tier hierarchy: standard < advanced (removed "expert" tier)
+- Simplified to two challenge tiers: "standard" and "advanced"
+
+## [0.14.0] - 2024-12-19
+
+### Added
+- **Modular Architecture**: Complete refactoring of the codebase for improved maintainability
+  - Split monolithic `dossier.py` into modular `dossier/` package with specialized modules
+  - Refactored CLI into `cli/` package with commands organized into separate modules
+  - Created `dossier/generator.py` for HTML generation logic
+  - Created `dossier/templates.py` for template management
+  - Created `dossier/utils.py` for dossier-specific utilities
+  - Created `cli/commands/` directory with specialized command modules
+  - Created `cli/utils.py` for CLI-specific utilities
+- **Enhanced Error Messaging**: Comprehensive error handling improvements
+  - Added actionable suggestions for common typos and parameter errors
+  - Integrated validation warnings with helpful guidance
+  - Enhanced CLI error messages with specific recommendations
+  - Added parameter validation with user-friendly error descriptions
+- **Improved CLI Help**: Enhanced command-line interface usability
+  - Added [BASIC] and [ADVANCED] tags to help users understand option complexity
+  - Improved option descriptions with practical usage examples
+  - Enhanced help text for complex parameters like `--limb-darkening-model`
+  - Added usage examples in command docstrings for better user guidance
+
+### Changed
+- **Code Organization**: Improved project structure and maintainability
+  - Separated concerns between dossier generation, CLI commands, and utilities
+  - Enhanced code readability and debugging capabilities
+  - Maintained backward compatibility with existing API and CLI interfaces
+  - Preserved all existing functionality while improving internal organization
+- **Documentation**: Updated internal documentation to reflect new modular structure
+  - Enhanced docstrings with usage examples and parameter descriptions
+  - Improved code comments for better developer experience
+  - Maintained user-facing documentation consistency
+
+### Fixed
+- **Maintainability**: Resolved technical debt through modularization
+  - Eliminated monolithic files that were difficult to maintain
+  - Improved test organization and coverage
+  - Enhanced code reusability and separation of concerns
+- **User Experience**: Better error handling and guidance
+  - More helpful error messages with actionable suggestions
+  - Clearer CLI help text with practical examples
+  - Improved parameter validation with user-friendly feedback
+
+## [0.13.0] - 2024-12-19
+
+### Added
+- **Bulk CSV Import**: New CLI command `import-solutions` and API function `import_solutions_from_csv()` for importing multiple solutions from a CSV file in one step
+  - Supports column mapping via YAML parameter map files
+  - Handles solution aliases with uniqueness validation within events
+  - Supports duplicate handling (error/override/ignore), notes, dry-run, and validation options
+  - Properly converts literal `\n` characters to actual newlines in notes from CSV files
+  - See the tutorial and README for usage examples
+- **Solution Aliases**: Human-readable identifiers for solutions with automatic uniqueness validation
+  - Aliases are displayed prominently in dossier generation and CLI output
+  - Integrated into all CLI commands that reference solutions
+  - Supports alias-based solution identification and management
+- **Enhanced Notes Handling**: Improved handling of notes with literal escape sequences
+  - CSV import automatically converts literal `\n` and `\r` to actual newlines
+  - Added `convert_escapes` parameter to `set_notes()` method for controlled conversion
+  - Maintains backward compatibility with existing notes functionality
+- **Test Data**: Added `tests/data/test_import.csv` as a comprehensive test file for CSV import functionality
+  - Used in both CLI and API tests as a real-world example and template for users
+  - Includes various parameter types, aliases, notes, and edge cases for testing
+
+### Changed
+- **Code Quality**: Improved formatting and readability throughout the codebase
+  - Added proper spacing and logical grouping in dense functions
+  - Enhanced code maintainability and debugging capabilities
+- **Documentation**: Updated tutorial, README, and API documentation to cover CSV import and alias features
+- **CLI Enhancements**: Added alias support to all solution-related CLI commands
+
+### Fixed
+- **Notes Rendering**: Fixed issue where literal `\n` characters in notes were rendered as text instead of line breaks in HTML
+  - CSV import now properly converts escape sequences to actual newlines
+  - Maintains compatibility with existing notes that don't need conversion
+
+## [0.12.2] - 2024-12-19
+
+### Fixed
+- **Critical Bug Fix**: Renamed `Solution.validate()` method to `Solution.run_validation()` to resolve Pydantic conflict
+  - Pydantic was interpreting the `validate` method as a field validator, causing import errors
+  - This was breaking Sphinx documentation generation and module imports
+  - All references updated across API, CLI, tests, and documentation
+  - Method functionality remains identical, only the name changed
+
+### Changed
+- Updated all documentation and examples to use `run_validation()` instead of `validate()`
+- Updated CLI commands and help text for consistency
+- Updated test suite to use the new method name
+
+## [0.12.1] - 2024-12-19
+
+### Added
+- **New CLI Command**: `set-hardware-info` for managing compute platform information
+  - Supports setting CPU, memory, platform, and Nexus image details
+  - Includes `--clear`, `--dry-run`, and update options
+  - Integrates with dossier generation for hardware documentation
+- **Enhanced Documentation**: Comprehensive improvements to Sphinx documentation
+  - Expanded API reference with detailed examples and best practices
+  - Enhanced tutorial with step-by-step workflow and troubleshooting
+  - Improved index page with key features and quick start guide
+  - Added custom CSS styling for RGES-PIT color scheme
+- **Example Parameter Files**: Created comprehensive example parameter files
+  - `tests/example_params.yaml` and `tests/example_params.json`
+  - Demonstrates different parameter formats, uncertainties, and model types
+  - Useful for testing and tutorial purposes
+
+### Changed
+- **Version Update**: Bumped version from v0.12.0-dev to v0.12.1
+- **Documentation**: Updated all version references across codebase
+- **Tutorial**: Updated CLI commands in `Submission_Tool_Tutorial.ipynb` to match current syntax
+- **GitHub Logo**: Ensured GitHub logo is properly packaged and included in dossier generation
+
+### Fixed
+- **CI Test Failures**: Fixed test assertions for CLI comparison and validation commands
+  - Updated table header counting logic for solution comparison output
+  - Added missing repo_url setting in validation tests
+- **Documentation Build**: Improved Sphinx configuration for better autodoc and theme options
+
+## [0.12.0] - 2024-12-18
+
+### Added
+- **Comprehensive Documentation**: Complete Sphinx documentation with API reference, tutorial, and examples
+- **Enhanced Dossier Generation**: Improved HTML dashboard with better styling and navigation
+- **Parameter File Support**: Added support for JSON and YAML parameter files in CLI
+- **Validation System**: Centralized parameter validation with comprehensive error checking
+- **Hardware Information**: Automatic detection and manual setting of compute platform details
+- **Notes Management**: Enhanced markdown notes support with file-based editing
+- **Solution Comparison**: BIC-based solution ranking and relative probability calculation
+- **Export Improvements**: Better handling of external files and automatic path updates
+
+### Changed
+- **API Improvements**: Enhanced Solution and Submission classes with better validation
+- **CLI Enhancements**: More robust command-line interface with better error handling
+- **Project Structure**: Improved organization with better separation of concerns
+
+### Fixed
+- **Bug Fixes**: Various fixes for data persistence, validation, and export functionality
+- **Documentation**: Comprehensive docstring updates with Google style formatting
+
+## [0.11.0] - 2024-12-17
+
+### Added
+- **Initial Release**: Basic submission management functionality
+- **Core API**: Solution, Event, and Submission classes
+- **CLI Interface**: Basic command-line tools for project management
+- **Export Functionality**: ZIP archive creation for submissions
+
+### Changed
+- **Project Structure**: Organized code into logical modules
+- **Documentation**: Basic README and docstrings
+
+### Fixed
+- **Initial Implementation**: Core functionality for microlensing submission management

microlens_submit-0.16.3/CITATION.cff

@@ -0,0 +1,9 @@
+cff-version: 1.2.0
+message: "If you use microlens-submit, please cite it as below."
+title: "microlens-submit"
+version: "0.16.3"
+authors:
+  - family-names: Malpas
+    given-names: Amber
+url: "https://github.com/AmberLee2427/microlens-submit"
+doi: "10.5281/zenodo.17468488"

{microlens_submit-0.16.2 → microlens_submit-0.16.3}/MANIFEST.in

@@ -1,2 +1,6 @@
 include microlens_submit/assets/rges-pit_logo.png
 include microlens_submit/assets/github-desktop_logo.png
+include pyproject.toml
+include README.md
+include CHANGELOG.md
+include CITATION.cff

{microlens_submit-0.16.2/microlens_submit.egg-info → microlens_submit-0.16.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microlens-submit
-Version: 0.16.2
+Version: 0.16.3
 Summary: A tool for managing and submitting microlensing solutions
 Home-page: https://github.com/AmberLee2427/microlens-submit
 Author: Amber Malpas
@@ -201,15 +201,15 @@ import this file directly.
 
 Bibtex:
 ```
-@software{malpas_2025_17460500,
+@software{malpas_2025_17468488,
   author       = {Malpas, Amber},
   title        = {microlens-submit},
   month        = oct,
   year         = 2025,
   publisher    = {Zenodo},
-  version      = {v0.16.1},
-  doi          = {10.5281/zenodo.17460500},
-  url          = {https://doi.org/10.5281/zenodo.17460500},
+  version      = {v0.16.3},
+  doi          = {10.5281/zenodo.17468488},
+  url          = {https://doi.org/10.5281/zenodo.17468488},
 }
 ```
 
@@ -217,4 +217,4 @@ Cite without version:
 Malpas, A. (2025). microlens-submit. Zenodo. https://doi.org/10.5281/zenodo.17459752
 
 Cite current version:
-Malpas, A. (2025). microlens-submit (v0.16.1). Zenodo. https://doi.org/10.5281/zenodo.17459753
+Malpas, A. (2025). microlens-submit (v0.16.3). Zenodo. https://doi.org/10.5281/zenodo.17468488

{microlens_submit-0.16.2 → microlens_submit-0.16.3}/README.md

@@ -152,15 +152,15 @@ import this file directly.
 
 Bibtex:
 ```
-@software{malpas_2025_17460500,
+@software{malpas_2025_17468488,
   author       = {Malpas, Amber},
   title        = {microlens-submit},
   month        = oct,
   year         = 2025,
   publisher    = {Zenodo},
-  version      = {v0.16.1},
-  doi          = {10.5281/zenodo.17460500},
-  url          = {https://doi.org/10.5281/zenodo.17460500},
+  version      = {v0.16.3},
+  doi          = {10.5281/zenodo.17468488},
+  url          = {https://doi.org/10.5281/zenodo.17468488},
 }
 ```
 
@@ -168,4 +168,4 @@ Cite without version:
 Malpas, A. (2025). microlens-submit. Zenodo. https://doi.org/10.5281/zenodo.17459752
 
 Cite current version:
-Malpas, A. (2025). microlens-submit (v0.16.1). Zenodo. https://doi.org/10.5281/zenodo.17459753
+Malpas, A. (2025). microlens-submit (v0.16.3). Zenodo. https://doi.org/10.5281/zenodo.17468488

{microlens_submit-0.16.2 → microlens_submit-0.16.3}/microlens_submit/__init__.py

@@ -5,7 +5,7 @@ validate, and export a challenge submission using either the Python API or
 the command line interface.
 """
 
-__version__ = "0.16.2"
+__version__ = "0.16.3"
 
 from .models import Event, Solution, Submission
 from .utils import load

{microlens_submit-0.16.2 → microlens_submit-0.16.3}/microlens_submit/text_symbols.py

@@ -9,6 +9,8 @@ otherwise falls back to a readable ASCII alternative.
 
 from __future__ import annotations
 
+import locale
+import os
 import sys
 from typing import Dict, Tuple
 
@@ -70,6 +72,25 @@ def symbol(name: str) -> str:
         fallback.
     """
     unicode_char, fallback = _SYMBOL_MAP.get(name, ("", ""))
-    if unicode_char and _can_encode(unicode_char):
+
+    if not unicode_char:
+        return fallback
+
+    # On Windows runners the locale is frequently a legacy code page (e.g. cp1252)
+    # even when rich/click report UTF-8.  Prefer ASCII fallbacks unless we can
+    # confidently detect a UTF-capable encoding.
+    if os.name == "nt":
+        candidate_encodings = [
+            os.environ.get("PYTHONIOENCODING"),
+            getattr(sys.stdout, "encoding", None),
+            getattr(sys.stderr, "encoding", None),
+            getattr(sys.__stdout__, "encoding", None),
+            getattr(sys.__stderr__, "encoding", None),
+            locale.getpreferredencoding(False),
+        ]
+        if not any(enc and "utf" in enc.lower() for enc in candidate_encodings if enc):
+            return fallback or unicode_char
+
+    if _can_encode(unicode_char):
         return unicode_char
     return fallback or unicode_char

{microlens_submit-0.16.2 → microlens_submit-0.16.3/microlens_submit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microlens-submit
-Version: 0.16.2
+Version: 0.16.3
 Summary: A tool for managing and submitting microlensing solutions
 Home-page: https://github.com/AmberLee2427/microlens-submit
 Author: Amber Malpas
@@ -201,15 +201,15 @@ import this file directly.
 
 Bibtex:
 ```
-@software{malpas_2025_17460500,
+@software{malpas_2025_17468488,
   author       = {Malpas, Amber},
   title        = {microlens-submit},
   month        = oct,
   year         = 2025,
   publisher    = {Zenodo},
-  version      = {v0.16.1},
-  doi          = {10.5281/zenodo.17460500},
-  url          = {https://doi.org/10.5281/zenodo.17460500},
+  version      = {v0.16.3},
+  doi          = {10.5281/zenodo.17468488},
+  url          = {https://doi.org/10.5281/zenodo.17468488},
 }
 ```
 
@@ -217,4 +217,4 @@ Cite without version:
 Malpas, A. (2025). microlens-submit. Zenodo. https://doi.org/10.5281/zenodo.17459752
 
 Cite current version:
-Malpas, A. (2025). microlens-submit (v0.16.1). Zenodo. https://doi.org/10.5281/zenodo.17459753
+Malpas, A. (2025). microlens-submit (v0.16.3). Zenodo. https://doi.org/10.5281/zenodo.17468488

{microlens_submit-0.16.2 → microlens_submit-0.16.3}/microlens_submit.egg-info/SOURCES.txt

@@ -1,3 +1,5 @@
+CHANGELOG.md
+CITATION.cff
 LICENSE
 MANIFEST.in
 README.md

{microlens_submit-0.16.2 → microlens_submit-0.16.3}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "microlens-submit"
-version = "0.16.2"
+version = "0.16.3"
 authors = [
   { name="Amber Malpas", email="malpas.1@osu.edu" },
   {name = "Roman Science Platform Team", email = "roman-science-platform@stsci.edu"}

{microlens_submit-0.16.2 → microlens_submit-0.16.3}/setup.py

@@ -8,7 +8,7 @@ from setuptools import find_packages, setup
 if __name__ == "__main__":
     setup(
         name="microlens-submit",
-        version="0.16.2",
+        version="0.16.3",
         packages=find_packages(include=("microlens_submit", "microlens_submit.*")),
         include_package_data=True,
         package_data={