microlens-submit 0.12.2__py3-none-any.whl → 0.16.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- microlens_submit/__init__.py +7 -157
- microlens_submit/cli/__init__.py +5 -0
- microlens_submit/cli/__main__.py +6 -0
- microlens_submit/cli/commands/__init__.py +1 -0
- microlens_submit/cli/commands/dossier.py +139 -0
- microlens_submit/cli/commands/export.py +177 -0
- microlens_submit/cli/commands/init.py +172 -0
- microlens_submit/cli/commands/solutions.py +722 -0
- microlens_submit/cli/commands/validation.py +241 -0
- microlens_submit/cli/main.py +120 -0
- microlens_submit/dossier/__init__.py +51 -0
- microlens_submit/dossier/dashboard.py +503 -0
- microlens_submit/dossier/event_page.py +370 -0
- microlens_submit/dossier/full_report.py +330 -0
- microlens_submit/dossier/solution_page.py +534 -0
- microlens_submit/dossier/utils.py +111 -0
- microlens_submit/error_messages.py +283 -0
- microlens_submit/models/__init__.py +28 -0
- microlens_submit/models/event.py +406 -0
- microlens_submit/models/solution.py +569 -0
- microlens_submit/models/submission.py +569 -0
- microlens_submit/tier_validation.py +208 -0
- microlens_submit/utils.py +373 -0
- microlens_submit/validate_parameters.py +478 -180
- {microlens_submit-0.12.2.dist-info → microlens_submit-0.16.1.dist-info}/METADATA +52 -14
- microlens_submit-0.16.1.dist-info/RECORD +32 -0
- microlens_submit/api.py +0 -1257
- microlens_submit/cli.py +0 -1803
- microlens_submit/dossier.py +0 -1443
- microlens_submit-0.12.2.dist-info/RECORD +0 -13
- {microlens_submit-0.12.2.dist-info → microlens_submit-0.16.1.dist-info}/WHEEL +0 -0
- {microlens_submit-0.12.2.dist-info → microlens_submit-0.16.1.dist-info}/entry_points.txt +0 -0
- {microlens_submit-0.12.2.dist-info → microlens_submit-0.16.1.dist-info}/licenses/LICENSE +0 -0
- {microlens_submit-0.12.2.dist-info → microlens_submit-0.16.1.dist-info}/top_level.txt +0 -0
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: microlens-submit
|
|
3
|
-
Version: 0.
|
|
4
|
-
Summary: A
|
|
3
|
+
Version: 0.16.1
|
|
4
|
+
Summary: A tool for managing and submitting microlensing solutions
|
|
5
|
+
Home-page: https://github.com/AmberLee2427/microlens-submit
|
|
6
|
+
Author: Amber Malpas
|
|
5
7
|
Author-email: Amber Malpas <malpas.1@osu.edu>, Roman Science Platform Team <roman-science-platform@stsci.edu>
|
|
6
8
|
License: MIT
|
|
7
9
|
Project-URL: Homepage, https://github.com/AmberLee2427/microlens-submit
|
|
@@ -27,6 +29,7 @@ Requires-Dist: typer[all]>=0.9.0
|
|
|
27
29
|
Requires-Dist: rich>=13.0.0
|
|
28
30
|
Requires-Dist: pyyaml>=6.0
|
|
29
31
|
Requires-Dist: markdown>=3.4.0
|
|
32
|
+
Requires-Dist: importlib_resources>=1.0.0; python_version < "3.9"
|
|
30
33
|
Provides-Extra: dev
|
|
31
34
|
Requires-Dist: pytest; extra == "dev"
|
|
32
35
|
Requires-Dist: pytest-cov; extra == "dev"
|
|
@@ -37,7 +40,11 @@ Requires-Dist: black; extra == "dev"
|
|
|
37
40
|
Requires-Dist: isort; extra == "dev"
|
|
38
41
|
Requires-Dist: sphinx; extra == "dev"
|
|
39
42
|
Requires-Dist: sphinx_rtd_theme; extra == "dev"
|
|
43
|
+
Requires-Dist: importlib_resources; extra == "dev"
|
|
44
|
+
Dynamic: author
|
|
45
|
+
Dynamic: home-page
|
|
40
46
|
Dynamic: license-file
|
|
47
|
+
Dynamic: requires-python
|
|
41
48
|
|
|
42
49
|
<p align="center">
|
|
43
50
|
<a href="https://github.com/AmberLee2427/microlens-submit">
|
|
@@ -49,15 +56,13 @@ Dynamic: license-file
|
|
|
49
56
|
|
|
50
57
|
*A stateful submission toolkit for the RGES-PIT Microlensing Data Challenge.*
|
|
51
58
|
|
|
52
|
-
[](https://github.com/AmberLee2427/microlens-submit/actions/workflows/ci.yml)
|
|
54
|
-
[](https://opensource.org/licenses/MIT)
|
|
59
|
+
[](https://pypi.org/project/microlens-submit/)[](https://microlens-submit.readthedocs.io/en/latest/?badge=latest)[](https://github.com/AmberLee2427/microlens-submit/actions/workflows/ci.yml)[](https://pypi.org/project/microlens-submit/)[](https://opensource.org/licenses/MIT)
|
|
55
60
|
|
|
56
61
|
<br>
|
|
57
62
|
|
|
58
63
|
`microlens-submit` provides a robust, version-controlled workflow for managing, validating, and packaging your challenge submission over a long period. It supports both a programmatic Python API and a full-featured Command Line Interface (CLI) for language-agnostic use.
|
|
59
64
|
|
|
60
|
-
Full documentation is hosted on [Read the Docs](https://microlens-submit.readthedocs.io/en/latest/). A comprehensive tutorial notebook is available at `docs/Submission_Tool_Tutorial.ipynb`. Challenge participants who prefer not to use this tool can consult [
|
|
65
|
+
Full documentation is hosted on [Read the Docs](https://microlens-submit.readthedocs.io/en/latest/). A comprehensive tutorial notebook is available at `docs/Submission_Tool_Tutorial.ipynb`. Challenge participants who prefer not to use this tool can consult the [Submission Manual](https://microlens-submit.readthedocs.io/en/latest/submission_manual.html) for the manual submission format.
|
|
61
66
|
|
|
62
67
|
## Key Features
|
|
63
68
|
|
|
@@ -72,10 +77,11 @@ Full documentation is hosted on [Read the Docs](https://microlens-submit.readthe
|
|
|
72
77
|
* **Environment Capture:** Automatically records your Python dependencies for each specific model fit, ensuring reproducibility.
|
|
73
78
|
* **Optional Posterior Storage:** Record the path to posterior samples for any solution.
|
|
74
79
|
* **Simple Export:** Packages all your active solutions into a clean, standardized `.zip` archive for final submission.
|
|
80
|
+
* **Bulk Import:** Import multiple solutions at once from a CSV file using the `import-solutions` CLI command. Supports column mapping, alias handling, duplicate handling, notes, dry-run, and validation options.
|
|
75
81
|
|
|
76
82
|
## Installation
|
|
77
83
|
|
|
78
|
-
The package is
|
|
84
|
+
The package is available on PyPI:
|
|
79
85
|
|
|
80
86
|
```bash
|
|
81
87
|
pip install microlens-submit
|
|
@@ -87,8 +93,21 @@ The CLI is the recommended way to interact with your submission project.
|
|
|
87
93
|
|
|
88
94
|
You can pass ``--no-color`` to any command if your terminal does not support ANSI colors.
|
|
89
95
|
|
|
90
|
-
1. Initialize your project:
|
|
96
|
+
1. Initialize your project:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
microlens-submit init --team-name "Planet Pounders" --tier "advanced"
|
|
100
|
+
# if a project directory was provided to `init`, you should now `cd` into that project
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
To pass validation, you need to have provided a `repo_url` and `hardware_info` to the project and have a git project initialized in your sumission-project directory.
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
microlens-submit set-repo-url <url> ./
|
|
107
|
+
microlens-submit set-hardware-info --cpu-details "intel i7 xxx" --ram-gb 32 ./
|
|
108
|
+
```
|
|
91
109
|
2. Add a new solution to an event:
|
|
110
|
+
|
|
92
111
|
```bash
|
|
93
112
|
microlens-submit add-solution ogle-2025-blg-0042 1S2L \
|
|
94
113
|
--param t0=555.5 \
|
|
@@ -96,14 +115,29 @@ You can pass ``--no-color`` to any command if your terminal does not support ANS
|
|
|
96
115
|
--param tE=25.0 \
|
|
97
116
|
--notes "This is a great fit!"
|
|
98
117
|
```
|
|
118
|
+
|
|
99
119
|
Model types must be one of `1S1L`, `1S2L`, `2S1L`, `2S2L`, `1S3L`, `2S3L`, or `other`.
|
|
100
120
|
This will create a new solution and print its unique `solution_id`.
|
|
121
|
+
|
|
101
122
|
You can run the same command with `--dry-run` first to verify the
|
|
102
123
|
parsed input without saving anything.
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
124
|
+
|
|
125
|
+
3. **Bulk import multiple solutions from a CSV file:**
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
microlens-submit import-solutions tests/data/test_import.csv --dry-run
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
See the file `tests/data/test_import.csv` for a comprehensive example covering all features and edge cases.
|
|
132
|
+
You can use this file as a template for your own imports.
|
|
133
|
+
|
|
134
|
+
4. Deactivate a solution that didn't work out: `microlens-submit deactivate <solution_id>`
|
|
135
|
+
|
|
136
|
+
5. List all solutions for an event: `microlens-submit list-solutions ogle-2025-blg-0042`
|
|
137
|
+
|
|
138
|
+
6. Validate solutions and check for issues: `microlens-submit validate-solution <solution_id>`
|
|
139
|
+
|
|
140
|
+
7. Export your final submission: `microlens-submit export final_submission.zip`
|
|
107
141
|
|
|
108
142
|
**Note:** When you add a solution, it's automatically validated and any warnings are displayed. Use `--dry-run` to check validation without saving.
|
|
109
143
|
|
|
@@ -139,7 +173,8 @@ sub.export("final_submission.zip")
|
|
|
139
173
|
|
|
140
174
|
The full development plan can be found in agents.md. Contributions are welcome!
|
|
141
175
|
|
|
142
|
-
To build and test this project, the development
|
|
176
|
+
To build and test this project, install the development dependencies using either `pip install -e .[dev]` or `pip install -r requirements-dev.txt`. These packages are required to run the test suite and are listed in `requirements-dev.txt`.
|
|
177
|
+
After installing the dependencies, run `pre-commit install` to set up the Git hooks for automatic formatting and linting. The development environment needs the following Python libraries.
|
|
143
178
|
|
|
144
179
|
### Core Dependencies:
|
|
145
180
|
* **`typer[all]`**: For building the powerful command-line interface. The `[all]` extra ensures shell completion support is included.
|
|
@@ -153,9 +188,12 @@ To build and test this project, the development environment needs the following
|
|
|
153
188
|
* **`build`**: For building the package from the `pyproject.toml` file.
|
|
154
189
|
* **`twine`**: For uploading the final package to PyPI.
|
|
155
190
|
|
|
191
|
+
### Test Data
|
|
192
|
+
|
|
193
|
+
A comprehensive test CSV file is provided at `tests/data/test_import.csv`. This file is used in the test suite and can be copied or adapted for your own bulk imports or for development/testing purposes.
|
|
194
|
+
|
|
156
195
|
## Citation
|
|
157
196
|
|
|
158
197
|
If you use **microlens-submit** in your research, please cite the project using
|
|
159
198
|
the metadata provided in the `CITATION.cff` file. Most reference managers can
|
|
160
199
|
import this file directly.
|
|
161
|
-
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
microlens_submit/__init__.py,sha256=cU8vO5jdCuI4cWhdTh0M3fV0L0qYtme1WDjtKq6osuw,399
|
|
2
|
+
microlens_submit/error_messages.py,sha256=BuTkzc1B2lve-G4-4wAUX5p3y6CthPFOcMJM6_eMN2I,10262
|
|
3
|
+
microlens_submit/tier_validation.py,sha256=mbE9MjXRHbsPBB12aD2lyYUdvXiBacweRG2OTWgP7Fs,6168
|
|
4
|
+
microlens_submit/utils.py,sha256=3kEinJXr5OWHjrQUGHhUFA6L2rNdqaLy2ogmQNx_TfY,14358
|
|
5
|
+
microlens_submit/validate_parameters.py,sha256=_RBzdbY2sFwtNNd5f69bwxTpHjlNq_np3iDYvio4Oow,37645
|
|
6
|
+
microlens_submit/assets/github-desktop_logo.png,sha256=pb4rallKrYQPHt6eC0TmJe_UyyMtf1IrP8_OWK19nH8,479821
|
|
7
|
+
microlens_submit/assets/rges-pit_logo.png,sha256=45AJypXCymvt3lMeK7MHt1SBhwPpnKCMj6S000Cejtc,537645
|
|
8
|
+
microlens_submit/cli/__init__.py,sha256=u4ZgVOzUe_gf89FBhY61XWjcfK4oxXCStabYTjBuRRo,82
|
|
9
|
+
microlens_submit/cli/__main__.py,sha256=_7x5Hd_9ehQwYHphd3iPB3LMVvKAVmxz-e0E4pWi0lk,112
|
|
10
|
+
microlens_submit/cli/main.py,sha256=iJ2bkQZ-OiuCUCVqs_EGbhpa240zB7agrYNZj6p5_3g,3938
|
|
11
|
+
microlens_submit/cli/commands/__init__.py,sha256=rzIgY7T2Bz4Lhzts_RiWeoBbMoCuxODxeoktnUhH4rw,49
|
|
12
|
+
microlens_submit/cli/commands/dossier.py,sha256=6gRJNzUgr29YmYJRcUj9aoiRhjb1r9Uy4dip6z2LaHI,5100
|
|
13
|
+
microlens_submit/cli/commands/export.py,sha256=Hr9frquBdla69s7Bi-Vx3XBQ0AJte562coIParmLQL8,6600
|
|
14
|
+
microlens_submit/cli/commands/init.py,sha256=LOnG63YJupk3ELFCRl9itDymtAe0eu9xf2BQ6D5xu50,7074
|
|
15
|
+
microlens_submit/cli/commands/solutions.py,sha256=E0aU4rtjRWToh8l1yrSJnPo6CRnLsx-2QAF5Rv1yMVs,30051
|
|
16
|
+
microlens_submit/cli/commands/validation.py,sha256=XNbuIy837IPV45ze4dvJaKx9-UCx24VXiGW_y4dl4YE,8841
|
|
17
|
+
microlens_submit/dossier/__init__.py,sha256=INAacbrY0Wi5ueH8c7b156bGzelyUFcynbE7_YRiku0,1948
|
|
18
|
+
microlens_submit/dossier/dashboard.py,sha256=4OvTUCxIC4LbAqKwimIFhi65fNo5MMJswiQ5OWtyWFA,19907
|
|
19
|
+
microlens_submit/dossier/event_page.py,sha256=F9waw-Ce2_4ikdCPo-hNURUSYEPGMCfvsY3PbCXpsFg,14425
|
|
20
|
+
microlens_submit/dossier/full_report.py,sha256=zQXoo6ZQfwv_NNFFel3ZYW1DgnqD--VU0L7J7p9yEng,12864
|
|
21
|
+
microlens_submit/dossier/solution_page.py,sha256=qp2JaDamHD__3bwOzZ3CRj2UUSCiOf94wNyOfkQUGGU,23593
|
|
22
|
+
microlens_submit/dossier/utils.py,sha256=LopBbVg6nzQasL1lnaI63y3bpmqYqBeDEwfB_NqEeCA,3845
|
|
23
|
+
microlens_submit/models/__init__.py,sha256=1sHFjAWyFtGgQBRSo8lBYiPzToo4tIoHP3uBjtgJSPY,861
|
|
24
|
+
microlens_submit/models/event.py,sha256=j5ulKGF2lVWXpIVcilCPftoXxMHwuYgD9ZjUz5vhlek,16941
|
|
25
|
+
microlens_submit/models/solution.py,sha256=0prKFYM3oxKXZjtzhaAaS7E5cYP2maxfbYNQhkL-IY0,23339
|
|
26
|
+
microlens_submit/models/submission.py,sha256=WgSgw6-60ZwLgsFjl2u1FX76ydATJ5t_DpGUQOekpg4,26116
|
|
27
|
+
microlens_submit-0.16.1.dist-info/licenses/LICENSE,sha256=cy1qkVR-kGxD6FXVsparmU2vHJXYeoyAAHv6SgT67sw,1069
|
|
28
|
+
microlens_submit-0.16.1.dist-info/METADATA,sha256=66B9Hiu35zyo6RjmNh8fe8RnZbnPrBk14PigILkKa1M,9487
|
|
29
|
+
microlens_submit-0.16.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
30
|
+
microlens_submit-0.16.1.dist-info/entry_points.txt,sha256=kA85yhxYrpQnUvVZCRS2giz52gaf1ZOfZFjY4RHIZ2s,62
|
|
31
|
+
microlens_submit-0.16.1.dist-info/top_level.txt,sha256=uJ9_bADYRySlhEpP-8vTm90ZLV2SrKEzutAaRx8WF0k,17
|
|
32
|
+
microlens_submit-0.16.1.dist-info/RECORD,,
|