Release version 0.1.0
NMMA Release Notes - Version 0.1.0
Previous Version: 0.0.19
Overview:
In our commitment to continuous improvement, we're excited to announce the release of NMMA v0.1.0. This release introduces significant changes to the NMMA project's packaging configuration, aligning with the latest best practices in the Python community.
Key Changes:
-
Transition to
pyproject.toml
:- We have transitioned from using
setup.py
to the modern standard,pyproject.toml
, for our project configuration. This ensures our project remains maintainable and easy to contribute to.
- We have transitioned from using
-
Entry Points Update:
-
The definition of our project's entry points (console scripts) has been modernized.
- Previously: Defined in
setup.py
underentry_points
. - Now: Defined in
pyproject.toml
under[project.scripts]
.
- Previously: Defined in
-
The new entry points:
nmma-generation = "nmma.pbilby.generation:main_nmma" nmma-gw-generation = "nmma.pbilby.generation:main_nmma_gw" nmma-analysis = "nmma.pbilby.analysis:main_nmma" nmma-gw-analysis = "nmma.pbilby.analysis:main_nmma_gw" lightcurve-analysis = "nmma.em.analysis:main" lightcurve-analysis-condor = "nmma.em.analysis_condor:main" lightcurve-injection-summary = "nmma.em.injection_summary:main" lightcurve-injection-slurm-setup = "nmma.em.create_injection_slurm:main" lightcurve-injection-condor-setup = "nmma.em.create_injection_condor:main" lightcurve-manual = "nmma.em.manual:main" lightcurve-marginalization = "nmma.em.lightcurve_marginalization:main" combine-EOS = "nmma.em.combine_EOS:main" create-lightcurve-slurm = "nmma.em.create_lightcurves_slurm:main" create-lightcurve-condor = "nmma.em.create_lightcurves_condor:main" create-svdmodel = "nmma.em.create_svdmodel:main" svdmodel-benchmark = "nmma.em.svdmodel_benchmark:main" svdmodel-download = "nmma.utils.models:main" lightcurve-generation = "nmma.em.create_lightcurves:main" lightcurve-detection = "nmma.em.detect_lightcurves:main" nmma-create-injection = "nmma.eos.create_injection:main" gwem-resampling = "nmma.em.gwem_resampling:main" gwem-resampling-condor = "nmma.em.gwem_resampling_condor:main" gwem-Hubble-estimate = "nmma.em.gwem_Hubble_estimate:main"
-
-
Installation from Source:
- The method to install the project from source has been updated:
- Previously:
python setup.py install
. - Now:
pip install .
- Or, for a development install:
pip install -e .
- Previously:
- The method to install the project from source has been updated:
Implications:
- Users will need to adapt to the new entry points and installation method.
- While the functionalities remain consistent, the command syntax has been updated. Users are encouraged to update their workflows accordingly.
Additional Information:
KNtimeshift
has now been renamed totimeshift
, make sure to use the new name since no more deprecation warning will be raised for this.- For a detailed overview of the NMMA library, its purpose, and usage instructions, refer to the documentation.
- NMMA now saves/loads the same core
.pkl
file regardless of interpolation type. Note that existing core files of the formmodel_tf.pkl
are identical tomodel.pkl
.
We believe these changes enhance the robustness of our project and simplify its management. We appreciate your continued support and understanding. For any queries or feedback regarding this release, please reach out to our team.
What's Changed
- Update docs by @sahiljhawar in #185
- restructured docs by @sahiljhawar in #191
- support for coveralls by @sahiljhawar in #192
- Update python-package.yml by @sahiljhawar in #193
- Fix datatype of redshift by @haukekoehn in #195
- Add coveralls by @sahiljhawar in #194
- Fix bug from redshift datatype conversion by @haukekoehn in #198
- corner plot script by @sahiljhawar in #186
- Update index.rst by @np699 in #199
- Fix API photometry filter naming and plot filename by @bfhealy in #200
- Add ultranest and tornado requirements by @bfhealy in #201
- rejection_sampling_argument in main.py by @haukekoehn in #204
- Add installation guide for custom lalsuite by @haukekoehn in #205
- Explain how the EM prior file needs to be updated by @haukekoehn in #207
- Rename Bu2022Ye KNtimeshift prior by @bfhealy in #208
- KNtimeshift -> timeshift by @mcoughlin in #209
- Changes to gwem_resampling_utils by @haukekoehn in #212
- Update filter docs by @mcoughlin in #223
- Caching and test for GP by @sahiljhawar in #224
- adds warning that KNtimeshift is deprecated by @tylerbarna in #226
- pinning GRB parameters by @sahiljhawar in #228
- Restrict scikit-learn version to <1.2 by @bfhealy in #231
- updated mac installation by @sahiljhawar in #232
- NMMA 2023 by @sahiljhawar in #233
- Fixed missing Sr2023 model by @weizmannk in #235
- Set random seed for python/numpy/tf during nn training by @bfhealy in #236
- Limit pandas to <2.0 for .pkl file compatibility by @bfhealy in #238
- Fix refresh models list typo by @tylerbarna in #239
- Replace setup.py with pyproject.toml by @mcoughlin in #242
- remove KNTimeshift deprecation warning by @tylerbarna in #243
New Contributors
Full Changelog: v0.0.19...0.1.0