Skip to content

add packages and links to algorithms doc #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AmberLee2427 wants to merge 11 commits into
base: main
Choose a base branch
from
Open

add packages and links to algorithms doc #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a15991a
Update algorithm table to include microlux
AmberLee2427 Feb 24, 2026
9228de1
Update fitting algorithms table and add microJax
AmberLee2427 Feb 24, 2026
73a0e42
Update package links in Model_Fitting_Algorithms.md
AmberLee2427 Feb 24, 2026
576cecb
Format package names as inline code
AmberLee2427 Feb 24, 2026
fa060eb
Merge branch 'MovingUniverseLab:main' into main
AmberLee2427 Feb 24, 2026
28e367a
Fix formatting of model definitions in documentation
AmberLee2427 Feb 24, 2026
3e2f592
Format GitHub and Documentation links in markdown
AmberLee2427 Feb 24, 2026
bd4add7
Fix algorithm usage in Model_Fitting_Algorithms.md
AmberLee2427 Feb 24, 2026
0cb0378
Add documentation link for VBMicrolensing package
AmberLee2427 Feb 24, 2026
29d5124
Fix spelling of 'Autodifferentiation' to 'Auto-Differentiation'
AmberLee2427 Feb 24, 2026
70c8762
Merge branch 'MovingUniverseLab:main' into main
AmberLee2427 Mar 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion List_of_codes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Below is a list of publicly available gravitational microlensing modeling packag

| Name and Repo | Docs | Language | Main Paper | Note |
|---------------|------|----------|------------|------|
| [VBMicrolensing](https://github.com/valboz/VBMicrolensing) | | C++, python wrapper | | model generation only |
| [VBMicrolensing](https://github.com/valboz/VBMicrolensing) | [docs](https://github.com/valboz/VBMicrolensing/tree/main/docs) | C++, python wrapper | | model generation only |
| [RTModel](https://github.com/valboz/RTModel) | [docs](https://github.com/valboz/RTModel/blob/main/docs/README.md) | C++, python wrapper | | model fitting (VBM for generation) |
| [pyLIMA](https://github.com/ebachelet/pyLIMA) | [docs](https://pylima.readthedocs.io/en/latest/) | python | | |
| [MulensModel](https://github.com/rpoleski/MulensModel) | [docs](https://rpoleski.github.io/MulensModel/) | python | | |
Expand Down
12 changes: 6 additions & 6 deletions Model_Class_Support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ This page describes the types of models (e.g. single-lens or binary lens) that a

## Defintions

VBM* = VBMicrolensing for model generation and RTModel for Fitting
MM = MulensModel
PSPL = Point Source, Point Lens (1S1L)
PSBL = Point Source, Binary Lens (1S2L)
BSPL = Binary Source, Point Lens (2S1L)
BSBL = Binary Source, Binary Lens (2S2L)
VBM* = VBMicrolensing for model generation and RTModel for Fitting
MM = MulensModel
PSPL = Point Source, Point Lens (1S1L)
PSBL = Point Source, Binary Lens (1S2L)
BSPL = Binary Source, Point Lens (2S1L)
BSBL = Binary Source, Binary Lens (2S2L)

| Feature | BAGLE | VBM* | MM | pyLIMA | RTModel | eesunhong |
|--------------------------------------------------------|-------|------|----|--------|---------|------------|
Expand Down
66 changes: 52 additions & 14 deletions Model_Fitting_Algorithms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,73 @@ This page details the fitting algorithms/processes supported by various microlen

## Overview

| Algorithm | BAGLE | VBM | MM | pyLIMA | RTModel | eesunhong |
|--------------------------------------------------------|-------|-----|----|--------|---------|------------|
| Uses Fitted Algorithm of Any Kind | Y | N | N | Y | Y | Y |
| | | | | | | |
| Binary Grid search | | | | | | Y |
| Differential Evolution | | | | Y | | |
| Nested Samples | Y | | | | | |
| Levenberg–Marquardt | | | | | Y | |
| Algorithm | BAGLE | VBM | MM | pyLIMA | RTModel | eesunhong | microlux | microJax |
|--------------------------------------------------------|-------|-----|----|--------|---------|-----------|----------|----------|
Comment on lines +7 to +8
Copy link

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The overview table uses microJax as the column name, but other docs in this repo use microjax (lowercase) and the GitHub repo is microjax. Please standardize the name/capitalization to avoid confusion and broken search matches.

Copilot uses AI. Check for mistakes.
| Uses Fitted Algorithm of Any Kind | Y | N | N | Y | Y | Y | N | N |
| | | | | | | | | |
| Binary Grid search | | | | | | Y | | |
| MCMC | | | | | | Y | | |
| Differential Evolution | | | | Y | | | | |
| Nested Samples | Y | | | | | | | |
| Levenberg–Marquardt | | | | | Y | | | |
| Auto-Differentiation | | | | | | | Y | Y |

## Package Specific Notes

<!-- ### ### BAGLE -->
### `BAGLE`

**GitHub Link:** [https://github.com/MovingUniverseLab/BAGLE_Microlensing](https://github.com/MovingUniverseLab/BAGLE_Microlensing)
**Documentation Link:** [https://bagle.readthedocs.io/en/latest/](https://bagle.readthedocs.io/en/latest/)


<!-- ### VBM -->
<!--
### `VBM`

**GitHub Link:** [https://github.com/valboz/VBMicrolensing](https://github.com/valboz/VBMicrolensing)
**Documentation Link:** [https://github.com/valboz/VBMicrolensing/tree/main/docs](https://github.com/valboz/VBMicrolensing/tree/main/docs)


<!-- ### MulensModel -->

### `MulensModel`

**GitHub Link:** [https://github.com/rpoleski/MulensModel](https://github.com/rpoleski/MulensModel)
**Documentation Link:** [https://rpoleski.github.io/MulensModel/](https://rpoleski.github.io/MulensModel/)
-->
Comment on lines +26 to +38
Copy link

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The VBM and MulensModel sections are wrapped in an HTML comment block, so their headings and links will not render in the published Markdown. If these sections are meant to be visible, remove the surrounding <!-- ... --> or narrow the comment to only the content you intend to hide.

Copilot uses AI. Check for mistakes.

<!-- ### pyLIMA -->


### pyLIMA

Comment on lines +42 to 43
Copy link

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Section headings use inconsistent formatting (e.g., ### BAGLE`` uses backticks, while ### pyLIMA does not). Please standardize heading formatting across packages so the document scans uniformly.

Copilot uses AI. Check for mistakes.
<!-- ### RTModel -->
**GitHub Link:** [https://github.com/ebachelet/pyLIMA](https://github.com/ebachelet/pyLIMA)
**Documentation Link:** [https://pylima.readthedocs.io/en/latest/](https://pylima.readthedocs.io/en/latest/)



<!-- ### essunhong -->
### RTModel

**GitHub Link:** [https://github.com/valboz/RTModel](https://github.com/valboz/RTModel)
**Documentation Link:** [https://github.com/valboz/RTModel/blob/main/docs/README.md](https://github.com/valboz/RTModel/blob/main/docs/README.md)



### essunhong
Copy link

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Package name heading is spelled essunhong, but elsewhere in this repo (table header and links) it’s eesunhong. This inconsistency makes it harder to search/scan the doc; please standardize the spelling.

Suggested change
### essunhong
### eesunhong

Copilot uses AI. Check for mistakes.

**GitHub Link:** [https://github.com/golmschenk/eesunhong](https://github.com/golmschenk/eesunhong)
**Documentation Link:** [https://eesunhong.readthedocs.io/en/latest/index.html](https://eesunhong.readthedocs.io/en/latest/index.html)


<!--
### `microlux`

**GitHub Link:** [https://github.com/CoastEgo/microlux](https://github.com/CoastEgo/microlux)
**Documentation Link:** [https://coastego.github.io/microlux/](https://coastego.github.io/microlux/)



### `microJAX`

**GitHub Link:** [https://github.com/ShotaMiyazaki94/microjax](https://github.com/ShotaMiyazaki94/microjax)
**Documentation Link:** [https://shotamiyazaki94.github.io/microjax/](https://shotamiyazaki94.github.io/microjax/)
-->
Comment on lines +62 to +74
Copy link

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The microlux / microJAX package notes are inside an HTML comment block, so the GitHub/Docs links won’t render. If the intent is to include these links on the page, remove the <!-- ... --> wrapper (or replace with a clear TODO note outside of an HTML comment).

Copilot uses AI. Check for mistakes.


Loading