Skip to content

Release version 0.1.0
Compare
Choose a tag to compare
@sahiljhawar sahiljhawar released this 20 Sep 00:19
· 340 commits to main since this release
v0.1.0
72dd9c7
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

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:

  1. 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.

  2. Entry Points Update:

    • The definition of our project's entry points (console scripts) has been modernized.

      • Previously: Defined in setup.py under entry_points.
      • Now: Defined in pyproject.toml under [project.scripts].

    • 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"

  3. 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 .

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 to timeshift, 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 form model_tf.pkl are identical to model.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

New Contributors

Full Changelog: v0.0.19...0.1.0

Contributors

mcoughlin, bfhealy, and 5 other contributors
Assets 2