Giter Club home page Giter Club logo

nrsurrogatecatalog's Introduction

This repository contains the code used to generate the NRSur catalog website and its API.

To generate the website, run:

build_nrsur_website --event-dir DIR_WITH_RESULTS --outdir out_test_website
ghp-import -n -p -f out_test_website/_build/html
upload_to_zenodo test_cache_dir
rm -rf test_cache_dir

Development

pip install -e .[dev]

Generate a test website:

python tests/generate_mock_data.py
upload_to_zenodo "tests/test_cache_dir/*.json"
build_nrsur_website --event-dir tests/test_cache_dir --outdir out_test_website
ghp-import -n -p -f out_test_website/_build/html
rm -rf test_cache_dir

nrsurrogatecatalog's People

Contributors

avivajpeyi avatar

Stargazers

Leo C. Stein avatar

Watchers

Richard O'Shaughnessy avatar Carl Haster avatar Shichao Wu avatar  avatar  avatar

nrsurrogatecatalog's Issues

API improvements

  • Official data to be hosted on zenodo
  • Convert files from json to h5 (much smaller)
  • Move results into a public (sandbox) zenodo for testing; no DOI generated
  • Test automated upload

website improvements

  • Masses should be in the source frame as thats what the paper is showing (add info to labels; otherwise document somewhere that these are source frame masses)
  • TOC at the top of each event page; e.g. header for each plot/table so the user could see whats throughout the page
  • NR Fits -> events
  • Add offical LVK posteriors. Possibly switch to toogle on/off the different models?
  • Summary page plots on the home page
  • NRSur7dq2 --> NRSur7dq4
  • For reproducibility: (i) yaml files for which the runs were done. PSD files and calibration envelopes should be easy to get to (either we give the data, or we provide link to where this can be found -- point to 2.1 and 3 data whenever possible)
  • Have versions and configurations (e.g. https://pycbc.org/3-ogc/posteriors/4._config_files/4.01_gw150914_095045/)

pesummary compatible?

Are the public posteriors compatible with pesummary (in addition to the custom nr-catalog package?)

store h5 instead of json?

Should we store the results as h5 instead of json? h5 files are much smaller in size i think...

We should probably investigate the size difference first.

Zenodo entry

I can't tell who submitted the zenodo record, but I figured this might be as good a place as any to suggest this: That record needs at least a little more detail in the description. It says, "Refer to the paper for more details. " But what paper? There should at least be a link to the arxiv version.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.