RTModel 2.0__tar.gz → 2.2__tar.gz

rtmodel-2.2/.github/workflows/run_tests.yml

@@ -0,0 +1,41 @@
+name: run_tests
+
+on: [push, pull_request]
+
+jobs:
+  run_tests:
+    name: run_tests_on_${{ matrix.os }}_python_${{ matrix.python_version }}_pip_install_flag_${{ matrix.pip_install_flag }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python_version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        pip_install_flag: ["none", "editable", "user"]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: setup_python_${{ matrix.python_version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python_version }}
+
+      - name: install
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+          if [ "${{ matrix.pip_install_flag }}" = "editable" ]; then
+            pip_install_flag="--editable"
+          elif [ "${{ matrix.pip_install_flag }}" = "user" ]; then
+            pip_install_flag="--user"
+          else
+            pip_install_flag=""
+          fi
+          pip install -v ${pip_install_flag} .
+
+      - name: test
+        run: |
+          pip install pytest
+          cd ..
+          python -m pytest RTModel/tests

rtmodel-2.2/.gitignore

@@ -0,0 +1,42 @@
+### C++ template
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+### Example user template template
+### Example user template
+
+# IntelliJ project files
+.idea
+*.iml
+out
+gen

rtmodel-2.2/CMakeLists.txt

@@ -0,0 +1,49 @@
+cmake_minimum_required(VERSION 3.19)
+
+project(RTModel LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+    set(MINIMUM_GCC_VERSION "9.0")
+    if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS MINIMUM_GCC_VERSION)
+        message(FATAL_ERROR "GCC must be ${MINIMUM_GCC_VERSION} or greater.")
+    endif()
+endif()
+
+# Build executables
+# =================
+
+add_executable(Reader RTModel/lib/Reader.cpp)
+target_include_directories(Reader PRIVATE RTModel/include)
+
+add_executable(InitCond RTModel/lib/InitCond.cpp)
+target_include_directories(InitCond PRIVATE RTModel/include)
+
+add_executable(LevMar RTModel/lib/bumper.cpp RTModel/lib/LevMar.cpp RTModel/lib/LevMarFit.cpp
+        RTModel/lib/VBMicrolensingLibrary.cpp)
+target_include_directories(LevMar PRIVATE RTModel/include)
+
+add_executable(ModelSelector RTModel/lib/bumper.cpp RTModel/lib/ModelSelector.cpp)
+target_include_directories(ModelSelector PRIVATE RTModel/include)
+
+add_executable(Finalizer RTModel/lib/bumper.cpp RTModel/lib/Finalizer.cpp)
+target_include_directories(Finalizer PRIVATE RTModel/include)
+
+# Install executables
+# ===================
+
+if(SKBUILD)  # Only run if called through scikit-build-core. That is, don't run when called through CMake directly.
+    set(binary_directory "${SKBUILD_PLATLIB_DIR}/RTModel/bin")
+
+    install(TARGETS Reader DESTINATION ${binary_directory})
+    install(TARGETS InitCond DESTINATION ${binary_directory})
+    install(TARGETS LevMar DESTINATION ${binary_directory})
+    install(TARGETS ModelSelector DESTINATION ${binary_directory})
+    install(TARGETS Finalizer DESTINATION ${binary_directory})
+
+    # Ensure data files are present in platlib.
+    add_custom_command(TARGET Reader POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy_directory
+            "${CMAKE_CURRENT_LIST_DIR}/RTModel/data" "${SKBUILD_PLATLIB_DIR}/RTModel/data")
+endif()

{RTModel-2.0 → rtmodel-2.2}/LICENSE

@@ -1,7 +1,8 @@
-                   GNU LESSER GENERAL PUBLIC LICENSE
+                 GNU LESSER GENERAL PUBLIC LICENSE
+
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 

{RTModel-2.0 → rtmodel-2.2}/MANIFEST.in

@@ -1,6 +1,5 @@
-include RTModel/bin/Reader.exe
 graft RTModel/data
 graft RTModel/lib
 graft RTModel/include
 graft RTModel/bin
-global-exclude RTModel/lib/*.o*
+global-exclude RTModel/lib/*.o*

{RTModel-2.0/RTModel.egg-info → rtmodel-2.2}/PKG-INFO

@@ -1,61 +1,78 @@
-Metadata-Version: 2.1
-Name: RTModel
-Version: 2.0
-Summary: RTModel is a tool for microlensing event interpretation.
-Author-email: Valerio Bozza <valboz@sa.infn.it>
-License: GPL-3.0
-Project-URL: Homepage, https://github.com/valboz/RTModel
-Keywords: Microlensing analysis and fitting
-Classifier: Development Status :: 1 - Planning
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Programming Language :: Python :: 3
-Requires-Python: <4,>=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy
-Requires-Dist: pytest
-Requires-Dist: matplotlib
-Requires-Dist: tqdm
-Requires-Dist: VBBinaryLensing>=3.7.0
-
-# RTModel
-`RTModel` is a package for modeling and interpretation of microlensing events. It uses photometric time series collected from ground and/or space telescopes to propose one or more possible models among the following:
-- Single-lens-single-source microlensing (i.e. Paczynski)
-- Single-lens-binary-source microlensing (with or without xallarap)
-- Binary-lens-single-source microlensing (including planetary microlensing, parallax and orbital motion)
-
-All models include the finite-size of the source(s).
-
-The modeling strategy is based on a grid search in the parameter space for single-lens models, whereas a **template library** for binary-lens models is used including all possible geometries of the source trajectory with respect to the caustics. In addition to this global search, planets are searched where maximal deviations from a Paczynski model occurs. 
-
-The library is in the form of a standard Python package that launches specific subprocesses for different tasks. Model fitting is executed in **parallel** exploiting available processors in the machine. The full modeling may take from one to three hours depending on the event and on the machine speed. The results of modeling are given in the form of a text **assessment file**; in addition, **final models** are made available with their parameters and covariance matrices.
-
-`RTModel` also includes a subpackage **`RTModel.plotmodel`** that allows an immediate visualization of models and the possibility to review each individual fitting process as an animated gif.
-
-## Attribution
-
-A paper is in preparation describing all algorithms behind RTModel in detail.
-At the moment, any use of this code for scientific publications should be acknowledged by citing this GitHub repository. 
-
-## Installation
-
-The easiest way to install `RTModel` is through `pip`
-```
-pip install RTModel
-```
-
-Currently, `RTModel` works on Linux and Windows, requiring Python >= 3.6. 
-A C++ compiler compatible with C++17 standard is needed for installation.
-`RTModel` also incorporates version 3.7 of [`VBBinaryLensing`](https://github.com/valboz/VBBinaryLensing).
-
-Example Jupyter notebooks will be included in `examples/`.
-
-## Documentation
-Provisional [documentation for the use of RTModel](docs/README.md) is available and under development.
-
-## License
-`RTModel` is freely available to the community under the 
-GNU Lesser General Public License Version 3 included in this repository.
-
-
+Metadata-Version: 2.1
+Name: RTModel
+Version: 2.2
+Summary: RTModel is a tool for microlensing event interpretation.
+Keywords: Microlensing analysis and fitting
+Author-Email: Valerio Bozza <valboz@sa.infn.it>
+License: GPL-3.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3
+Project-URL: Homepage, https://github.com/valboz/RTModel
+Requires-Python: <4,>=3.6
+Requires-Dist: numpy
+Requires-Dist: pytest
+Requires-Dist: matplotlib
+Requires-Dist: tqdm
+Requires-Dist: VBMicrolensing>=4.1.0
+Description-Content-Type: text/markdown
+
+# RTModel
+`RTModel` is a package for modeling and interpretation of microlensing events. It uses photometric time series collected from ground and/or space telescopes to propose one or more possible models among the following:
+- Single-lens-single-source microlensing (i.e. Paczynski)
+- Single-lens-binary-source microlensing (with or without xallarap)
+- Binary-lens-single-source microlensing (including planetary microlensing, parallax and orbital motion)
+
+All models include the finite-size of the source(s).
+
+The modeling strategy is based on a grid search in the parameter space for single-lens models, whereas a **template library** for binary-lens models is used including all possible geometries of the source trajectory with respect to the caustics. In addition to this global search, planets are searched where maximal deviations from a Paczynski model occurs. 
+
+The library is in the form of a standard Python package that launches specific subprocesses for different tasks. Model fitting is executed in **parallel** exploiting available processors in the machine. The full modeling may take from one to three hours depending on the event and on the machine speed. The results of modeling are given in the form of a text **assessment file**; in addition, **final models** are made available with their parameters and covariance matrices.
+
+`RTModel` also includes a subpackage **`RTModel.plotmodel`** that allows an immediate visualization of models and the possibility to review each individual fitting process as an animated gif.
+
+A second subpackage **`RTModel.templates`** helps the user in the visualization and customization of the template library.
+
+## Attribution
+
+`RTModel` has been created by Valerio Bozza (University of Salerno) as a product of many years of direct experience on microlensing modeling (see [RTModel webpage](http://www.fisica.unisa.it/GravitationAstrophysics/RTModel.htm)). 
+
+Any scientific use of `RTModel` should be acknowledged by citing the paper [V.Bozza, A&A 688 (2024) 83](https://ui.adsabs.harvard.edu/abs/2024A%26A...688A..83B/abstract), describing all the algorithms behind the code.
+
+We are grateful to Greg Olmschenk, who revised the package installation in order to make it as cross-platform as possible.
+
+## Installation
+
+The easiest way to install `RTModel` is through `pip`. 
+
+First clone this repository.
+
+Then go to the repository directory and type
+
+```
+pip install .
+```
+
+In alternative, you may directly install it from PyPI without cloning this repository:
+
+```
+pip install RTModel
+```
+
+Currently, `RTModel` works on Linux, Windows and MacOS, requiring Python >= 3.6. 
+A C++ compiler compatible with C++17 standard is needed for installation.
+`RTModel` also incorporates version 4.1 of [`VBMicrolensing`](https://github.com/valboz/VBMicrolensing). You are encouraged to cite the relevant papers listed in that repository as well.
+
+## Documentation
+Full [documentation for the use of RTModel](docs/README.md) is available.
+
+In the directory [events](events) we provide some microlensing data on which you may practise with `RTModel`.
+
+A Jupyter notebook for quick start-up is also available in the [jupyter](jupyter) folder.
+
+## License
+`RTModel` is freely available to the community under the 
+GNU Lesser General Public License Version 3 included in this repository.
+
+

RTModel-2.0/PKG-INFO → rtmodel-2.2/README.md

@@ -1,61 +1,58 @@
-Metadata-Version: 2.1
-Name: RTModel
-Version: 2.0
-Summary: RTModel is a tool for microlensing event interpretation.
-Author-email: Valerio Bozza <valboz@sa.infn.it>
-License: GPL-3.0
-Project-URL: Homepage, https://github.com/valboz/RTModel
-Keywords: Microlensing analysis and fitting
-Classifier: Development Status :: 1 - Planning
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Programming Language :: Python :: 3
-Requires-Python: <4,>=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy
-Requires-Dist: pytest
-Requires-Dist: matplotlib
-Requires-Dist: tqdm
-Requires-Dist: VBBinaryLensing>=3.7.0
-
-# RTModel
-`RTModel` is a package for modeling and interpretation of microlensing events. It uses photometric time series collected from ground and/or space telescopes to propose one or more possible models among the following:
-- Single-lens-single-source microlensing (i.e. Paczynski)
-- Single-lens-binary-source microlensing (with or without xallarap)
-- Binary-lens-single-source microlensing (including planetary microlensing, parallax and orbital motion)
-
-All models include the finite-size of the source(s).
-
-The modeling strategy is based on a grid search in the parameter space for single-lens models, whereas a **template library** for binary-lens models is used including all possible geometries of the source trajectory with respect to the caustics. In addition to this global search, planets are searched where maximal deviations from a Paczynski model occurs. 
-
-The library is in the form of a standard Python package that launches specific subprocesses for different tasks. Model fitting is executed in **parallel** exploiting available processors in the machine. The full modeling may take from one to three hours depending on the event and on the machine speed. The results of modeling are given in the form of a text **assessment file**; in addition, **final models** are made available with their parameters and covariance matrices.
-
-`RTModel` also includes a subpackage **`RTModel.plotmodel`** that allows an immediate visualization of models and the possibility to review each individual fitting process as an animated gif.
-
-## Attribution
-
-A paper is in preparation describing all algorithms behind RTModel in detail.
-At the moment, any use of this code for scientific publications should be acknowledged by citing this GitHub repository. 
-
-## Installation
-
-The easiest way to install `RTModel` is through `pip`
-```
-pip install RTModel
-```
-
-Currently, `RTModel` works on Linux and Windows, requiring Python >= 3.6. 
-A C++ compiler compatible with C++17 standard is needed for installation.
-`RTModel` also incorporates version 3.7 of [`VBBinaryLensing`](https://github.com/valboz/VBBinaryLensing).
-
-Example Jupyter notebooks will be included in `examples/`.
-
-## Documentation
-Provisional [documentation for the use of RTModel](docs/README.md) is available and under development.
-
-## License
-`RTModel` is freely available to the community under the 
-GNU Lesser General Public License Version 3 included in this repository.
-
-
+# RTModel
+`RTModel` is a package for modeling and interpretation of microlensing events. It uses photometric time series collected from ground and/or space telescopes to propose one or more possible models among the following:
+- Single-lens-single-source microlensing (i.e. Paczynski)
+- Single-lens-binary-source microlensing (with or without xallarap)
+- Binary-lens-single-source microlensing (including planetary microlensing, parallax and orbital motion)
+
+All models include the finite-size of the source(s).
+
+The modeling strategy is based on a grid search in the parameter space for single-lens models, whereas a **template library** for binary-lens models is used including all possible geometries of the source trajectory with respect to the caustics. In addition to this global search, planets are searched where maximal deviations from a Paczynski model occurs. 
+
+The library is in the form of a standard Python package that launches specific subprocesses for different tasks. Model fitting is executed in **parallel** exploiting available processors in the machine. The full modeling may take from one to three hours depending on the event and on the machine speed. The results of modeling are given in the form of a text **assessment file**; in addition, **final models** are made available with their parameters and covariance matrices.
+
+`RTModel` also includes a subpackage **`RTModel.plotmodel`** that allows an immediate visualization of models and the possibility to review each individual fitting process as an animated gif.
+
+A second subpackage **`RTModel.templates`** helps the user in the visualization and customization of the template library.
+
+## Attribution
+
+`RTModel` has been created by Valerio Bozza (University of Salerno) as a product of many years of direct experience on microlensing modeling (see [RTModel webpage](http://www.fisica.unisa.it/GravitationAstrophysics/RTModel.htm)). 
+
+Any scientific use of `RTModel` should be acknowledged by citing the paper [V.Bozza, A&A 688 (2024) 83](https://ui.adsabs.harvard.edu/abs/2024A%26A...688A..83B/abstract), describing all the algorithms behind the code.
+
+We are grateful to Greg Olmschenk, who revised the package installation in order to make it as cross-platform as possible.
+
+## Installation
+
+The easiest way to install `RTModel` is through `pip`. 
+
+First clone this repository.
+
+Then go to the repository directory and type
+
+```
+pip install .
+```
+
+In alternative, you may directly install it from PyPI without cloning this repository:
+
+```
+pip install RTModel
+```
+
+Currently, `RTModel` works on Linux, Windows and MacOS, requiring Python >= 3.6. 
+A C++ compiler compatible with C++17 standard is needed for installation.
+`RTModel` also incorporates version 4.1 of [`VBMicrolensing`](https://github.com/valboz/VBMicrolensing). You are encouraged to cite the relevant papers listed in that repository as well.
+
+## Documentation
+Full [documentation for the use of RTModel](docs/README.md) is available.
+
+In the directory [events](events) we provide some microlensing data on which you may practise with `RTModel`.
+
+A Jupyter notebook for quick start-up is also available in the [jupyter](jupyter) folder.
+
+## License
+`RTModel` is freely available to the community under the 
+GNU Lesser General Public License Version 3 included in this repository.
+
+