microlens-submit 0.12.1__py3-none-any.whl → 0.12.2__py3-none-any.whl

microlens_submit/__init__.py

@@ -156,7 +156,7 @@ Note:
     Tailwind CSS styling and syntax-highlighted markdown notes.
 """
 
-__version__ = "0.12.1"
+__version__ = "0.12.2"
 
 from .api import Event, Solution, Submission, load
 

microlens_submit/api.py

@@ -85,7 +85,8 @@ class Solution(BaseModel):
         relative_probability: Optional probability of this solution being the best model.
         n_data_points: Number of data points used in the fit.
         creation_timestamp: UTC timestamp when the solution was created.
-        
+
+
     Example:
         >>> from microlens_submit import load
         >>> 
@@ -111,19 +112,23 @@ class Solution(BaseModel):
         >>> solution.set_compute_info(cpu_hours=2.5, wall_time_hours=0.5)
         >>> 
         >>> # Add notes
-        >>> solution.set_notes("# My Solution Notes\n\nThis is a simple point lens fit.")
+        >>> solution.set_notes('''
+        ...     # My Solution Notes
+        ...
+        ...     This is a simple point lens fit.
+        ... ''')
         >>> 
         >>> # Validate the solution
-        >>> messages = solution.validate()
+        >>> messages = solution.run_validation()
         >>> if messages:
         ...     print("Validation issues:", messages)
-        
+
     Note:
         The notes_path field supports Markdown formatting, allowing you to create rich,
         structured documentation with headers, lists, code blocks, tables, and links.
         This is particularly useful for creating detailed submission dossiers for evaluators.
         
-        The validate() method performs comprehensive validation of parameters,
+        The run_validation() method performs comprehensive validation of parameters,
         higher-order effects, and physical consistency. Always validate solutions
         before submission.
     """
@@ -286,43 +291,21 @@ class Solution(BaseModel):
         """
         self.is_active = True
 
-    def validate(self) -> list[str]:
+    def run_validation(self) -> list[str]:
         """Validate this solution's parameters and configuration.
         
         This method performs comprehensive validation using centralized validation logic
         to ensure the solution is complete, consistent, and ready for submission.
         
-        **Validation Checks:**
-        
-        **Parameter Completeness:**
-        - Ensures all required parameters are present for the given model type
-        - Validates higher-order effect requirements (e.g., parallax needs piEN, piEE)
-        - Checks band-specific flux parameters when bands are specified
-        - Verifies t_ref is provided when required by time-dependent effects
-        
-        **Parameter Types and Values:**
-        - Validates parameter data types (float, int, string)
-        - Checks physically meaningful parameter ranges
-        - Ensures positive values for quantities that must be positive (tE, s, etc.)
-        - Validates mass ratio (q) is between 0 and 1
-        
-        **Physical Consistency:**
-        - Checks for physically impossible parameter combinations
-        - Validates binary lens separation ranges for caustic crossing
-        - Ensures relative_probability is between 0 and 1 when specified
-        
-        **Model-Specific Validation:**
-        - 1S1L: Requires t0, u0, tE
-        - 1S2L: Requires t0, u0, tE, s, q, alpha
-        - 2S1L: Requires t0, u0, tE (core lens parameters)
-        - Higher-order effects: Validates effect-specific parameters
+        The validation includes:
         
-        **Higher-Order Effects Supported:**
-        - parallax: Requires piEN, piEE, t_ref
-        - finite-source: Requires rho
-        - lens-orbital-motion: Requires dsdt, dadt, t_ref
-        - gaussian-process: Optional ln_K, ln_lambda, ln_period, ln_gamma
-        - fitted-limb-darkening: Optional u1, u2, u3, u4
+        * Parameter completeness for the given model type
+        * Higher-order effect requirements (e.g., parallax needs piEN, piEE)
+        * Band-specific flux parameters when bands are specified
+        * Reference time requirements for time-dependent effects
+        * Parameter data types and physically meaningful ranges
+        * Physical consistency checks
+        * Model-specific parameter requirements
         
         Args:
             None
@@ -334,7 +317,7 @@ class Solution(BaseModel):
                       
         Example:
             >>> solution = event.add_solution("1S2L", {"t0": 2459123.5, "u0": 0.1})
-            >>> messages = solution.validate()
+            >>> messages = solution.run_validation()
             >>> if messages:
             ...     print("Validation issues found:")
             ...     for msg in messages:
@@ -782,7 +765,7 @@ class Submission(BaseModel):
         >>> solution2 = event2.add_solution("1S2L", {"t0": 2459156.2, "u0": 0.08, "tE": 35.7, "s": 0.95, "q": 0.0005, "alpha": 78.3})
         >>> 
         >>> # Validate the submission
-        >>> warnings = submission.validate()
+        >>> warnings = submission.run_validation()
         >>> if warnings:
         ...     print("Validation warnings:")
         ...     for warning in warnings:
@@ -809,7 +792,7 @@ class Submission(BaseModel):
     events: Dict[str, Event] = Field(default_factory=dict)
     repo_url: Optional[str] = None
 
-    def validate(self) -> list[str]:
+    def run_validation(self) -> list[str]:
         """Check the submission for missing or incomplete information.
 
         The method performs lightweight validation and returns a list of
@@ -824,7 +807,7 @@ class Submission(BaseModel):
             >>> submission = load("./my_project")
             >>> 
             >>> # Validate the submission
-            >>> warnings = submission.validate()
+            >>> warnings = submission.run_validation()
             >>> if warnings:
             ...     print("Validation warnings:")
             ...     for warning in warnings:
@@ -875,7 +858,7 @@ class Submission(BaseModel):
             
             for sol in active:
                 # Use the new centralized validation
-                solution_messages = sol.validate()
+                solution_messages = sol.run_validation()
                 for msg in solution_messages:
                     warnings.append(f"Solution {sol.solution_id} in event {event.event_id}: {msg}")
                 
@@ -1060,7 +1043,7 @@ class Submission(BaseModel):
             >>> submission = load("./my_project")
             >>> 
             >>> # Validate before export
-            >>> warnings = submission.validate()
+            >>> warnings = submission.run_validation()
             >>> if warnings:
             ...     print("Fix validation issues before export:", warnings)
             ... else:

microlens_submit/cli.py

@@ -556,7 +556,7 @@ def add_solution(
         console.print(json.dumps(parsed, indent=2))
         console.print(Panel("Schema Output", style="cyan"))
         console.print(sol.model_dump_json(indent=2))
-        validation_messages = sol.validate()
+        validation_messages = sol.run_validation()
         if validation_messages:
             console.print(Panel("Validation Warnings", style="yellow"))
             for msg in validation_messages:
@@ -576,7 +576,7 @@ def add_solution(
             canonical_notes_path.parent.mkdir(parents=True, exist_ok=True)
             canonical_notes_path.write_text("", encoding="utf-8")
     sub.save()
-    validation_messages = sol.validate()
+    validation_messages = sol.run_validation()
     if validation_messages:
         console.print(Panel("Validation Warnings", style="yellow"))
         for msg in validation_messages:
@@ -715,7 +715,7 @@ def export(
         that don't have them set, using BIC if sufficient data is available.
     """
     sub = load(str(project_path))
-    warnings = sub.validate()
+    warnings = sub.run_validation()
     if warnings:
         console.print(Panel("Validation Warnings", style="yellow"))
         for w in warnings:
@@ -1072,7 +1072,7 @@ def validate_solution(
         raise typer.Exit(code=1)
 
     # Run validation
-    messages = target_solution.validate()
+    messages = target_solution.run_validation()
 
     if not messages:
         console.print(
@@ -1143,7 +1143,7 @@ def validate_submission(
         all required information is present and valid.
     """
     sub = load(str(project_path))
-    warnings = sub.validate()
+    warnings = sub.run_validation()
 
     # Check for missing repo_url
     repo_url_warning = next((w for w in warnings if 'repo_url' in w.lower() or 'github' in w.lower()), None)
@@ -1213,7 +1213,7 @@ def validate_event(
     console.print(Panel(f"Validating Event: {event_id}", style="cyan"))
 
     for solution in event.solutions.values():
-        messages = solution.validate()
+        messages = solution.run_validation()
         if messages:
             console.print(f"\n[bold]Solution {solution.solution_id}:[/bold]")
             for msg in messages:

microlens_submit/dossier.py

@@ -414,7 +414,7 @@ def _generate_dashboard_content(submission: Submission, full_dossier_exists: boo
 
             <!-- Footer -->
             <div class="text-sm text-gray-500 text-center pt-8 pb-6">
-                Generated by microlens-submit v0.12.1 on {datetime.now().strftime('%Y-%m-%d %H:%M:%S UTC')}
+                Generated by microlens-submit v0.12.2 on {datetime.now().strftime('%Y-%m-%d %H:%M:%S UTC')}
             </div>
 
             <!-- Regex Finish -->
@@ -760,7 +760,7 @@ def _generate_event_page_content(event: Event, submission: Submission) -> str:
 
             <!-- Footer -->
             <div class='text-sm text-gray-500 text-center pt-8 border-t border-gray-200 mt-10'>
-                Generated by microlens-submit v0.12.1 on {datetime.now().strftime('%Y-%m-%d %H:%M:%S UTC')}
+                Generated by microlens-submit v0.12.2 on {datetime.now().strftime('%Y-%m-%d %H:%M:%S UTC')}
             </div>
 
             <!-- Regex Finish -->
@@ -1129,7 +1129,7 @@ def _generate_solution_page_content(solution: Solution, event: Event, submission
 
             <!-- Footer -->
             <div class='text-sm text-gray-500 text-center pt-8 border-t border-gray-200 mt-10'>
-                Generated by microlens-submit v0.12.1 on {datetime.now().strftime('%Y-%m-%d %H:%M:%S UTC')}
+                Generated by microlens-submit v0.12.2 on {datetime.now().strftime('%Y-%m-%d %H:%M:%S UTC')}
             </div>
 
             <!-- Regex Finish -->

{microlens_submit-0.12.1.dist-info → microlens_submit-0.12.2.dist-info}/METADATA

@@ -1,24 +1,32 @@
 Metadata-Version: 2.4
 Name: microlens-submit
-Version: 0.12.1
-Summary: A stateful submission toolkit for the Microlensing Data Challenge.
-Author-email: Amber Malpas <malpas.1@osu.edu>
+Version: 0.12.2
+Summary: A toolkit for managing microlensing data challenge submissions
+Author-email: Amber Malpas <malpas.1@osu.edu>, Roman Science Platform Team <roman-science-platform@stsci.edu>
 License: MIT
 Project-URL: Homepage, https://github.com/AmberLee2427/microlens-submit
 Project-URL: Repository, https://github.com/AmberLee2427/microlens-submit
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 3 - Alpha
+Keywords: astronomy,microlensing,data-challenge,submission,roman
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Physics
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: pydantic>=2.0.0
 Requires-Dist: typer[all]>=0.9.0
-Requires-Dist: pydantic>=2.0
-Requires-Dist: rich>=13.0
-Requires-Dist: PyYAML>=6.0
-Requires-Dist: markdown>=3.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: markdown>=3.4.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -41,7 +49,7 @@ Dynamic: license-file
 
 *A stateful submission toolkit for the RGES-PIT Microlensing Data Challenge.*
 
-[![PyPI - v0.12.1](https://img.shields.io/pypi/v/microlens-submit.svg)](https://pypi.org/project/microlens-submit/)
+[![PyPI - v0.12.2](https://img.shields.io/pypi/v/microlens-submit.svg)](https://pypi.org/project/microlens-submit/)
 [![CI](https://github.com/AmberLee2427/microlens-submit/actions/workflows/ci.yml/badge.svg)](https://github.com/AmberLee2427/microlens-submit/actions/workflows/ci.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
@@ -67,13 +75,7 @@ Full documentation is hosted on [Read the Docs](https://microlens-submit.readthe
 
 ## Installation
 
-This package is pre-release. It is currently available on TestPyPI:
-
-```bash
-pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple microlens-submit==0.12.0-dev
-```
-
-The package will be available on PyPI:
+The package is be available on PyPI:
 
 ```bash
 pip install microlens-submit

microlens_submit-0.12.2.dist-info/RECORD

@@ -0,0 +1,13 @@
+microlens_submit/__init__.py,sha256=hqh7949_hPebaPxdSPsmEvA1KWU_VqhCRv7oVupPsAM,5869
+microlens_submit/api.py,sha256=dSBC0sHQPbR_VKnlcN0-_OHEzhTunMqGnj96cHY5xBg,52902
+microlens_submit/cli.py,sha256=peRC3otnrUOKPIYdLXpvao5zSVSEQOKBP-rqcR7FQlc,78754
+microlens_submit/dossier.py,sha256=iIaNdeVmyLuUHgxMhYIIlGqzhQWZOwichYRNCQSMiNY,65415
+microlens_submit/validate_parameters.py,sha256=GNma6rIl_VompJ7eyGJnT3nQ0v_PFJW1pZVBqVj5UTA,30767
+microlens_submit/assets/github-desktop_logo.png,sha256=pb4rallKrYQPHt6eC0TmJe_UyyMtf1IrP8_OWK19nH8,479821
+microlens_submit/assets/rges-pit_logo.png,sha256=45AJypXCymvt3lMeK7MHt1SBhwPpnKCMj6S000Cejtc,537645
+microlens_submit-0.12.2.dist-info/licenses/LICENSE,sha256=cy1qkVR-kGxD6FXVsparmU2vHJXYeoyAAHv6SgT67sw,1069
+microlens_submit-0.12.2.dist-info/METADATA,sha256=wHNZbe5g5SuAD3O6B40rfFyhY9yChuTJ8YhyLVaGZvg,7466
+microlens_submit-0.12.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+microlens_submit-0.12.2.dist-info/entry_points.txt,sha256=kA85yhxYrpQnUvVZCRS2giz52gaf1ZOfZFjY4RHIZ2s,62
+microlens_submit-0.12.2.dist-info/top_level.txt,sha256=uJ9_bADYRySlhEpP-8vTm90ZLV2SrKEzutAaRx8WF0k,17
+microlens_submit-0.12.2.dist-info/RECORD,,

microlens_submit-0.12.1.dist-info/RECORD

@@ -1,13 +0,0 @@
-microlens_submit/__init__.py,sha256=hBD9NA-AbajbMaVGS8_5xNvvWsLGBON0bXIK3kDK-jA,5869
-microlens_submit/api.py,sha256=p_EqHPBA7kkOMa1GzPj1_fTy4J63uyzkI41l1O3_IlA,53885
-microlens_submit/cli.py,sha256=SpO3d8v2_SswFNZFDkNQ4K0Oj-EXkDYmR5309123D6o,78718
-microlens_submit/dossier.py,sha256=tvWSh0JaSrPK5O7c_xULDkKNxCxBnUfaUgm9dFMUsrA,65415
-microlens_submit/validate_parameters.py,sha256=GNma6rIl_VompJ7eyGJnT3nQ0v_PFJW1pZVBqVj5UTA,30767
-microlens_submit/assets/github-desktop_logo.png,sha256=pb4rallKrYQPHt6eC0TmJe_UyyMtf1IrP8_OWK19nH8,479821
-microlens_submit/assets/rges-pit_logo.png,sha256=45AJypXCymvt3lMeK7MHt1SBhwPpnKCMj6S000Cejtc,537645
-microlens_submit-0.12.1.dist-info/licenses/LICENSE,sha256=cy1qkVR-kGxD6FXVsparmU2vHJXYeoyAAHv6SgT67sw,1069
-microlens_submit-0.12.1.dist-info/METADATA,sha256=qoO8paDd7MhdTpuJNbPI09i8Ij20RUlee27me7if5Uc,7177
-microlens_submit-0.12.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-microlens_submit-0.12.1.dist-info/entry_points.txt,sha256=kA85yhxYrpQnUvVZCRS2giz52gaf1ZOfZFjY4RHIZ2s,62
-microlens_submit-0.12.1.dist-info/top_level.txt,sha256=uJ9_bADYRySlhEpP-8vTm90ZLV2SrKEzutAaRx8WF0k,17
-microlens_submit-0.12.1.dist-info/RECORD,,