diff --git a/List_of_codes.md b/List_of_codes.md index 333f29f..8dc892a 100644 --- a/List_of_codes.md +++ b/List_of_codes.md @@ -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 | | | diff --git a/Model_Class_Support.md b/Model_Class_Support.md index ffc294f..5315cd3 100644 --- a/Model_Class_Support.md +++ b/Model_Class_Support.md @@ -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 | |--------------------------------------------------------|-------|------|----|--------|---------|------------| diff --git a/Model_Fitting_Algorithms.md b/Model_Fitting_Algorithms.md index 92faf2b..0713135 100644 --- a/Model_Fitting_Algorithms.md +++ b/Model_Fitting_Algorithms.md @@ -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 | +|--------------------------------------------------------|-------|-----|----|--------|---------|-----------|----------|----------| +| 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` +**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/) - + +### `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/) +--> - +### pyLIMA - +**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/) - +### 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 + +**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) + + + + +