nmma 0.1.3__tar.gz → 0.2.1__tar.gz

{nmma-0.1.3 → nmma-0.2.1}/.gitattributes

@@ -20,7 +20,7 @@
 
 # not sure about .prior files or .json files
 
-# image files 
+# image files
 *.png binary
 *.jpg binary
 *.gif binary
@@ -28,6 +28,7 @@
 *.pdf binary
 
 # binary files
+*.joblib binary
 *.pkl binary
 *.pickle binary
 *.h5 binary

{nmma-0.1.3 → nmma-0.2.1}/.github/workflows/build-deploy-container.yml

@@ -8,6 +8,7 @@ env:
 
 jobs:
   build:
+    if: github.repository_owner == 'nuclear-multimessenger-astronomy'
     runs-on: ubuntu-latest
 
     strategy:
@@ -41,7 +42,7 @@ jobs:
 
       - name: Build and push
         id: build
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./api/Dockerfile
@@ -64,37 +65,38 @@ jobs:
           retention-days: 1
 
   merge:
-      runs-on: ubuntu-latest
-      needs:
-        - build
-      steps:
-        - name: Download digests
-          uses: actions/download-artifact@v3
-          with:
-            name: digests
-            path: /tmp/digests
-
-        - name: Docker meta
-          id: meta
-          uses: docker/metadata-action@v4
-          with:
-            images: ${{ env.REGISTRY_IMAGE }}
-
-        - name: Set up Docker Buildx
-          uses: docker/setup-buildx-action@v2
-
-        - name: Login to Docker Hub
-          uses: docker/login-action@v2
-          with:
-            username: ${{ secrets.DOCKER_HUB_USERNAME }}
-            password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
-
-        - name: Create manifest list and push
-          working-directory: /tmp/digests
-          run: |
-            docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
-              $(printf '${{ env.REGISTRY_IMAGE }}@sha256:%s ' *)
-        -
-          name: Inspect image
-          run: |
-            docker buildx imagetools inspect ${{ env.REGISTRY_IMAGE }}:${{ steps.meta.outputs.version }}
+    if: github.repository_owner == 'nuclear-multimessenger-astronomy'
+    runs-on: ubuntu-latest
+    needs:
+      - build
+    steps:
+      - name: Download digests
+        uses: actions/download-artifact@v3
+        with:
+          name: digests
+          path: /tmp/digests
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY_IMAGE }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+      - name: Create manifest list and push
+        working-directory: /tmp/digests
+        run: |
+          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf '${{ env.REGISTRY_IMAGE }}@sha256:%s ' *)
+      -
+        name: Inspect image
+        run: |
+          docker buildx imagetools inspect ${{ env.REGISTRY_IMAGE }}:${{ steps.meta.outputs.version }}

nmma-0.2.1/.github/workflows/continous_integration.yml

@@ -0,0 +1,153 @@
+name: Unit Test nmma
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - "doc/**"
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - "doc/**"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash -el {0}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest", "macos-latest"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Checkout branch being tested
+        uses: actions/checkout@v4
+
+      - name: Set up Python with Conda ${{ matrix.python-version }}
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: ${{ matrix.os == 'macos-latest' && 'arm64' || 'x86_64' }}
+          miniforge-version: latest
+          use-mamba: true
+          mamba-version: "*"
+          activate-environment: nmma_env
+
+      - name: Restore SVD models from cache
+        uses: actions/cache@v4
+        with:
+          path: svdmodels
+          key: svdmodels-${{ hashFiles('**/LICENSE') }}
+          restore-keys: svdmodels-
+          save-always: true
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          echo "::set-output name=dir::$(pip cache dir)"
+
+      - name: pip cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-2-${{ hashFiles('**/pyproject.toml', '**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-2-
+          save-always: true
+
+      - name: Update Homebrew
+        if: matrix.os == 'macos-latest'
+        run: |
+          brew update --preinstall
+
+      - name: Configure Homebrew cache
+        if: matrix.os == 'macos-latest'
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/Library/Caches/Homebrew/openmpi--*
+            ~/Library/Caches/Homebrew/downloads/*--openmpi-*
+            ~/Library/Caches/Homebrew/hdf5--*
+            ~/Library/Caches/Homebrew/downloads/*--hdf5-*
+            ~/Library/Caches/Homebrew/gcc--*
+            ~/Library/Caches/Homebrew/downloads/*--gcc-*
+            ~/Library/Caches/Homebrew/openblas--*
+            ~/Library/Caches/Homebrew/downloads/*--openblas-*
+            ~/Library/Caches/Homebrew/lapack--*
+            ~/Library/Caches/Homebrew/downloads/*--lapack-*
+            ~/Library/Caches/Homebrew/basictex--*
+            ~/Library/Caches/Homebrew/downloads/*--basictex-*
+            ~/Library/Caches/Homebrew/cmake--*
+            ~/Library/Caches/Homebrew/downloads/*--cmake-*
+
+          key: brew-${{ hashFiles('**/pyproject.toml') }}
+          restore-keys: brew-
+          save-always: true
+
+      - name: Install Homebrew dependencies
+        if: matrix.os == 'macos-latest'
+        run: |
+          env HOMEBREW_NO_AUTO_UPDATE=1 brew install openmpi hdf5 gcc openblas lapack basictex cmake
+          eval "$(/usr/libexec/path_helper)"
+          sudo tlmgr update --self
+          sudo tlmgr install collection-latex
+          sudo tlmgr install collection-fontsrecommended
+          sudo tlmgr install dvipng
+          sudo tlmgr install cm-super
+          sudo tlmgr install type1cm
+      - name: Install Linux Dependencies
+        if: matrix.os == 'ubuntu-latest'
+        uses: awalsh128/cache-apt-pkgs-action@latest
+        with:
+          packages: openmpi-bin libopenmpi-dev gfortran build-essential libblas3 libblas-dev liblapack3 liblapack-dev libatlas-base-dev texlive texlive-latex-extra texlive-fonts-recommended dvipng cm-super
+          execute_install_scripts: true
+
+      - name: Install dependencies (macOS)
+        if: matrix.os == 'macos-latest'
+        run: |
+          conda install -c conda-forge pyfftw c-compiler ligo-segments python-ligo-lw
+          echo "FC=$(which gfortran-11)" >> $GITHUB_ENV
+          echo "CC=$(which gcc)" >> $GITHUB_ENV
+          echo "CXX=$(which g++)" >> $GITHUB_ENV
+
+      - name: Install dependencies (Ubuntu)
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y texlive texlive-latex-extra texlive-fonts-recommended dvipng cm-super
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade git+https://github.com/bitranox/wrapt_timeout_decorator.git
+          python -m pip install pytest pytest-cov flake8 pytest-aiohttp sqlparse freezegun PyJWT joblib coveralls
+          python -m pip install -r  ml_requirements.txt -r grb_requirements.txt -r tf_requirements.txt -r sklearn_requirements.txt
+          python -m pip install .
+          git clone https://github.com/JohannesBuchner/MultiNest && cd MultiNest/build && rm -rf * && cmake .. && make && cd ../..
+          pwd
+
+      - name: Export Libraries
+        run: |
+          echo "LD_LIBRARY_PATH=$HOME/work/nmma/nmma/MultiNest/lib:$LD_LIBRARY_PATH" >> $GITHUB_ENV
+          echo "DYLD_LIBRARY_PATH=$HOME/work/nmma/nmma/MultiNest/lib:$DYLD_LIBRARY_PATH" >> $GITHUB_ENV
+
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude docs
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --exclude docs,versioneer.py,nmma/_version.py,nmma/tests,nmma/*/__init__.py
+
+      - name: Test with pytest
+        run: |
+          python -m coverage run --source nmma -m pytest nmma/tests/*.py
+
+      - name: Run Coveralls
+        if: ${{ success() }}
+        run: |
+          coveralls --service=github
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

nmma-0.2.1/.github/workflows/dependency-installation.yml

@@ -0,0 +1,85 @@
+name: Check NMMA dependencies installation
+on:
+  push:
+    branches: [main]
+    paths: ["*_requirements.txt", "pyproject.toml"]
+  pull_request:
+    branches: [main]
+    paths: ["*_requirements.txt", "pyproject.toml"]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash -el {0}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest", "macos-latest"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Checkout branch being tested
+        uses: actions/checkout@v4
+
+      - name: Set up Python with Conda ${{ matrix.python-version }}
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: ${{ matrix.os == 'macos-latest' && 'arm64' || 'x86_64' }}
+          miniforge-version: latest
+          use-mamba: true
+          mamba-version: "*"
+          activate-environment: nmma_env
+
+      - name: Install linux packages
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y openmpi-bin libopenmpi-dev
+
+      - name: Install Homebrew packages
+        if: matrix.os == 'macos-latest'
+        run: |
+          brew install openmpi hdf5
+          conda install ligo-segments python-ligo-lw
+
+      - name: Install NMMA (base)
+        run: |
+          python -m pip install 'nmma @ git+https://github.com/sahiljhawar/nmma.git@dependencies'
+
+      - name: Verify base NMMA installation
+        run: |
+          python -c "import nmma; print(f'NMMA version: {nmma.__version__}')"
+
+      - name: Install and verify NMMA [grb]
+        run: |
+          python -m pip install 'nmma[grb] @ git+https://github.com/sahiljhawar/nmma.git@dependencies'
+          python -c "import nmma, afterglowpy; print(f'Successfully imported {nmma.__name__}, {afterglowpy.__name__}')"
+
+      - name: Install and verify NMMA [production]
+        run: |
+          python -m pip install 'nmma[production] @ git+https://github.com/sahiljhawar/nmma.git@dependencies'
+          python -c "import nmma, parallel_bilby, nestcheck, mpi4py; print(f'Successfully imported {nmma.__name__}, {parallel_bilby.__name__}, {nestcheck.__name__}, {mpi4py.__name__}')"
+
+      - name: Install and verify NMMA [neuralnet]
+        run: |
+          python -m pip install 'nmma[neuralnet] @ git+https://github.com/sahiljhawar/nmma.git@dependencies'
+          python -c "import nmma, torch, nflows, torchvision; print(f'Successfully imported {nmma.__name__}, {torch.__name__}, {nflows.__name__}, {torchvision.__name__}')"
+
+      - name: Install and verify NMMA [tf]
+        run: |
+          python -m pip install 'nmma[tf] @ git+https://github.com/sahiljhawar/nmma.git@dependencies'
+          python -c "import nmma, tensorflow; print(f'Successfully imported {nmma.__name__}, {tensorflow.__name__}')"
+
+      - name: Install and verify NMMA [sklearn]
+        run: |
+          python -m pip install 'nmma[sklearn] @ git+https://github.com/sahiljhawar/nmma.git@dependencies'
+          python -c "import nmma, sklearn; print(f'Successfully imported {nmma.__name__}, {sklearn.__name__}')"
+
+      - name: Install and verify NMMA [sampler]
+        run: |
+          python -m pip install 'nmma[sampler] @ git+https://github.com/sahiljhawar/nmma.git@dependencies'
+          python -c "import nmma, ultranest; print(f'Successfully imported {nmma.__name__}, {ultranest.__name__}')"

{nmma-0.1.3 → nmma-0.2.1}/.github/workflows/deploy-github-pages.yml

@@ -6,7 +6,6 @@ on:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -40,15 +39,18 @@ jobs:
         python -m pip install .[doc]
 
     - name: Make dependencies
+      env:
+        SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.SPHINX_GITHUB_CHANGELOG_TOKEN }}
       run: |
         cd doc && make html; cd ../
         touch doc/_build/html/.nojekyll
 
     - name: Deploy to GitHub Pages
-      if: success()
+      if: success() && github.repository_owner == 'nuclear-multimessenger-astronomy'
       uses: crazy-max/ghaction-github-pages@v2
       with:
         target_branch: gh-pages
         build_dir: doc/_build/html/
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.SPHINX_GITHUB_CHANGELOG_TOKEN }}

nmma-0.2.1/.github/workflows/rst-linter.yml

@@ -0,0 +1,22 @@
+name: Lint rst
+
+on:
+    push:
+        paths: ['**/**.rst']
+    pull_request:
+        paths: ['**/**.rst']
+
+jobs:
+    doctor-rst:
+        name: DOCtor-RST
+        runs-on: ubuntu-latest
+        steps:
+            - name: "Checkout code"
+              uses: actions/checkout@v4
+
+            - name: DOCtor-RST
+              uses: docker://oskarstark/doctor-rst
+              with:
+                  args: --short --error-format=github
+              env:
+                  DOCS_DIR: 'doc/'

nmma-0.2.1/CITATION.cff

@@ -0,0 +1,54 @@
+cff-version: 1.2.0
+title: "NMMA"
+abstract: "An updated nuclear-physics and multi-messenger astrophysics framework for binary neutron star mergers"
+message: "If you use this code, please cite this repository along with the paper"
+repository-code: "https://github.com/nuclear-multimessenger-astronomy/nmma"
+url: "https://gitlab.com/Theodlz/nmma-models"
+license: "GPL-3.0"
+authors:
+- given-names: "Peter"
+  name-particle: "T. H."
+  family-names: "Pang"
+- given-names: "Tim"
+  family-names: "Dietrich"
+- given-names: "Michael"
+  family-names: "Coughlin"
+  name-particle: "W."
+- given-names: "Mattia"
+  family-names: "Bulla"
+- given-names: "Ingo"
+  family-names: "Tews"
+- given-names: "Mouza"
+  family-names: "Almualla"
+- given-names: "Tyler"
+  family-names: "Barna"
+- given-names: "Weizmann"
+  family-names: "Kiendrebeogo"
+- given-names: "Nina"
+  family-names: "Kunert"
+- given-names: "Gargi"
+  family-names: "Mansingh"
+- given-names: "Brandon"
+  family-names: "Reed"
+- given-names: "Niharika"
+  family-names: "Sravan"
+- given-names: "Andrew"
+  family-names: "Toivonen"
+- given-names: "Sarah"
+  family-names: "Antier"
+- given-names: "Robert"
+  family-names: "VandenBerg"
+  name-particle: "O."
+- given-names: "Jack"
+  family-names: "Heinzel"
+- given-names: "Vsevolod"
+  family-names: "Nedora"
+- given-names: "Pouyan"
+  family-names: "Salehi"
+- given-names: "Ritwik"
+  family-names: "Sharma"
+- given-names: "Rahul"
+  family-names: "Somasundaram"
+- given-names: "Chris"
+  name-particle: "Van Den"
+  family-names: "Broeck"

nmma-0.2.1/Dockerfile

@@ -0,0 +1,58 @@
+# Use official Ubuntu 22.04 image as base
+FROM ubuntu:22.04
+
+# Update the repository for package indexes
+RUN apt-get update
+
+# Install dependencies
+RUN apt-get install -y \
+    python3 \
+    git \
+    python3-pip \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set work directory
+WORKDIR /work
+
+# Clone the Git repository
+RUN git clone https://github.com/nuclear-multimessenger-astronomy/nmma/
+
+# Set the working directory to the cloned repository
+WORKDIR /work/nmma
+
+RUN apt-get update
+RUN apt-get install -y libopenmpi-dev openmpi-bin openmpi-doc
+RUN apt install -y python3-mpi4py
+#install dependencies
+RUN pip3 install numpy
+RUN pip3 install -r /work/nmma/doc_requirements.txt -r /work/nmma/grb_requirements.txt -r /work/nmma/production_requirements.txt -r /work/nmma/requirements.txt
+
+# Clone and build Multinest
+RUN git clone https://github.com/JohannesBuchner/MultiNest
+
+WORKDIR /work/nmma/MultiNest
+
+RUN apt-get install -y \
+    cmake \
+    liblapacke-dev \
+    liblapack-dev \
+    libblas-dev 
+
+RUN cd build && cmake .. && make
+
+# Set environment variable
+ENV LD_LIBRARY_PATH=/work/nmma/MultiNest/lib:$LD_LIBRARY_PATH
+
+# Clone and install PyMultiNest
+RUN git clone https://github.com/JohannesBuchner/PyMultiNest/ /work/nmma/PyMultiNest
+WORKDIR /work/nmma/PyMultiNest
+RUN python3 setup.py install --user
+
+# Add the executable path to the enviromental variable PATH
+ENV PATH=$PATH:$HOME/.local/bin/
+
+RUN pip3 install nmma
+RUN pip3 install --upgrade Flask Jinja2
+
+CMD ["bash"]

nmma-0.2.1/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.1
+Name: nmma
+Version: 0.2.1
+Summary: A nuclear physics multi-messenger Bayesian inference library
+Author-email: "Peter Tsun Ho Pang, Michael Coughlin, Tim Dietrich, Ingo Tews" <nuclear_multimessenger_astronomy@googlegroups.com>
+License: GPLv3
+Project-URL: Homepage, https://github.com/nuclear-multimessenger-astronomy/nmma
+Project-URL: Documentation, https://nuclear-multimessenger-astronomy.github.io/nmma/
+Project-URL: Download, https://pypi.org/project/nmma/#files
+Project-URL: Tracker, https://github.com/nuclear-multimessenger-astronomy/nmma/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Requires-Python: <3.13,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: future
+Requires-Dist: bilby>=2.1.1
+Requires-Dist: bilby_pipe>=1.1.0
+Requires-Dist: colorcet
+Requires-Dist: numpy>=1.9
+Requires-Dist: matplotlib<3.8,>=2.0
+Requires-Dist: scipy>=1.10
+Requires-Dist: pandas<2.0,>=1.3.4
+Requires-Dist: astropy>=4.3.1
+Requires-Dist: pymultinest
+Requires-Dist: sncosmo
+Requires-Dist: dust_extinction
+Requires-Dist: arviz
+Requires-Dist: p_tqdm
+Requires-Dist: tornado
+Requires-Dist: notebook
+Requires-Dist: ligo.skymap
+Requires-Dist: healpy
+Provides-Extra: doc
+Requires-Dist: sphinx>=5.0; extra == "doc"
+Requires-Dist: sphinx_math_dollar; extra == "doc"
+Requires-Dist: recommonmark; extra == "doc"
+Requires-Dist: numpydoc; extra == "doc"
+Requires-Dist: sphinx-rtd-theme; extra == "doc"
+Requires-Dist: notedown; extra == "doc"
+Requires-Dist: jsx-lexer; extra == "doc"
+Requires-Dist: linkify-it-py; extra == "doc"
+Requires-Dist: linkify; extra == "doc"
+Requires-Dist: myst-parser; extra == "doc"
+Requires-Dist: sphinx-book-theme; extra == "doc"
+Requires-Dist: sphinx_copybutton; extra == "doc"
+Requires-Dist: sphinx-github-changelog; extra == "doc"
+Provides-Extra: grb
+Requires-Dist: afterglowpy>=0.7.3; extra == "grb"
+Requires-Dist: wrapt_timeout_decorator; extra == "grb"
+Provides-Extra: production
+Requires-Dist: parallel_bilby>=2.0.2; extra == "production"
+Requires-Dist: nestcheck; extra == "production"
+Requires-Dist: mpi4py; extra == "production"
+Provides-Extra: neuralnet
+Requires-Dist: torch; extra == "neuralnet"
+Requires-Dist: nflows; extra == "neuralnet"
+Requires-Dist: torchvision; extra == "neuralnet"
+Provides-Extra: sklearn
+Requires-Dist: scikit-learn>=1.0.2; extra == "sklearn"
+Provides-Extra: tf
+Requires-Dist: tensorflow; extra == "tf"
+Provides-Extra: sampler
+Requires-Dist: ultranest; extra == "sampler"
+
+<p align="center">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" width="600px" height="300px" srcset="https://github.com/nuclear-multimessenger-astronomy/nmma/blob/main/doc/images/dark-logo.svg">
+      <source media="(prefers-color-scheme: light)" width="600px" height="300px" srcset="https://github.com/nuclear-multimessenger-astronomy/nmma/blob/main/doc/images/light-logo.svg">
+      <img alt="NMMA">
+    </picture>
+</p>
+
+
+<div align="center">
+   <h1>NMMA</h1>
+   <h2>a pythonic library for probing nuclear physics and cosmology with multimessenger analysis</h2>
+   <br/><br/>
+</div>
+
+
+[![GitHub Repo stars](https://img.shields.io/github/stars/nuclear-multimessenger-astronomy/nmma?style=flat)](https://github.com/nuclear-multimessenger-astronomy/nmma/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/nuclear-multimessenger-astronomy/nmma?style=flat&color=%2365c563)](https://github.com/nuclear-multimessenger-astronomy/nmma/forks)
+[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/nmma?label=conda%20downloads)](https://anaconda.org/conda-forge/nmma)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/nmma?label=PyPI%20downloads)](https://badge.fury.io/py/nmma)
+[![Coverage Status](https://coveralls.io/repos/github/nuclear-multimessenger-astronomy/nmma/badge.svg?branch=main)](https://coveralls.io/github/nuclear-multimessenger-astronomy/nmma?branch=main)
+[![CI](https://github.com/nuclear-multimessenger-astronomy/nmma/actions/workflows/continous_integration.yml/badge.svg)](https://github.com/nuclear-multimessenger-astronomy/nmma/actions/workflows/continous_integration.yml)
+[![PyPI version](https://badge.fury.io/py/nmma.svg)](https://badge.fury.io/py/nmma)
+[![Python version](https://img.shields.io/pypi/pyversions/nmma.svg)](https://badge.fury.io/py/nmma)
+
+
+
+
+Citations to the NMMA code: [Citation record](https://inspirehep.net/literature?sort=mostrecent&size=250&page=1&q=refersto%3Arecid%3A2083145&ui-citation-summary=true)
+
+Read our official documentation: [NMMA Documentation](https://nuclear-multimessenger-astronomy.github.io/nmma/)
+
+Check out our contribution guide: [For contributors](https://nuclear-multimessenger-astronomy.github.io/nmma/contributing.html)
+
+A tutorial on how to produce simulations of lightcurves is given here [tutorial-lightcurve_simulation.ipynb](https://github.com/nuclear-multimessenger-astronomy/nmma/blob/main/tutorials/tutorial-lightcurve_simulation.ipynb)
+
+
+### Citing NMMA
+
+When utilizing this code for a publication, kindly make a reference to the package by its name, NMMA, and a citation to the companion paper [An updated nuclear-physics and multi-messenger astrophysics framework for binary neutron star mergers](https://www.nature.com/articles/s41467-023-43932-6). The BibTeX entry for the paper is:
+```bibtex
+@article{Pang:2022rzc,
+      title={An updated nuclear-physics and multi-messenger astrophysics framework for binary neutron star mergers},
+      author={Peter T. H. Pang and Tim Dietrich and Michael W. Coughlin and Mattia Bulla and Ingo Tews and Mouza Almualla and Tyler Barna and Weizmann Kiendrebeogo and Nina Kunert and Gargi Mansingh and Brandon Reed and Niharika Sravan and Andrew Toivonen and Sarah Antier and Robert O. VandenBerg and Jack Heinzel and Vsevolod Nedora and Pouyan Salehi and Ritwik Sharma and Rahul Somasundaram and Chris Van Den Broeck},
+      journal={Nature Communications},
+      year={2023},
+      month={Dec},
+      day={20},
+      volume={14},
+      number={1},
+      pages={8352},
+      issn={2041-1723},
+      doi={10.1038/s41467-023-43932-6},
+      url={https://doi.org/10.1038/s41467-023-43932-6}
+}
+```
+
+### Acknowledgments
+If you benefited from participating in our community, we ask that you please acknowledge the Nuclear Multi-Messenger Astronomy collaboration, and particular individuals who helped you, in any publications.
+Please use the following text for this acknowledgment:
+  > We acknowledge the Nuclear Multi-Messenger Astronomy collective as an open community of multi-domain experts and collaborators. This community and \<names of individuals\>, in particular, were important for the development of this project.
+
+### Funding
+We gratefully acknowledge previous and current support from the U.S. National Science Foundation (NSF) Harnessing the Data Revolution (HDR) Institute for <a href="https://a3d3.ai">Accelerating AI Algorithms for Data Driven Discovery (A3D3)</a> under Cooperative Agreement No. <a href="https://www.nsf.gov/awardsearch/showAward?AWD_ID=2117997">PHY-2117997</a> and the European Research Council (ERC) under the European Union's Starting Grant (Grant No. <a href="https://doi.org/10.3030/101076369">101076369</a>).
+
+<p align="center">
+<img src="https://github.com/nuclear-multimessenger-astronomy/nmma/blob/main/assets/a3d3.png" alt="A3D3" width="200"/>
+<img src="https://github.com/nuclear-multimessenger-astronomy/nmma/blob/main/assets/nsf.png" alt="NSF" width="200"/>
+<img src="https://github.com/nuclear-multimessenger-astronomy/nmma/blob/main/assets/erc.png" alt="ERC" width="200"/>