Giter VIP home page Giter VIP logo

descqa's Introduction

DESCQA

DOI Paper DOI arXiv:1709.09665 ascl:1804.011

This repository contains the DESCQA framework that validates simulated galaxy catalogs. For more information about this framework, please check out the DESCQA paper.

A web interface hosted on NERSC displays recent validation results from the DESCQA framework.

! Important ! Starting from DESCQA v2 (current version), we have separated the configurations and readers of catalogs from DESCQA and moved them to a standalone repo, the GCRCatalogs repo. We have also changed much of the validation tests. If you are looking for the catalogs and tests in DESCQA v1 (as presented in the companion paper), please see the v1 subdirectory.

Example of running a test in DESCQA

To run a sample DESCQA test from the command-line:

git clone [email protected]:LSSTDESC/descqa
cd descqa
sh run_master.sh -c cosmoDC2_v1.1.4_small -t SkyArea

See "How to run DESCQA?" section in CONTRIBUTING.md for more options that you can use with the run script.

Quick start guide to making tests

  1. First of all, try accessing the catalogs! You can find information about the catalogs in this Confluence page and this presentation (video). However, the easiest way to start is to go to https://jupyter.nersc.gov and login with your NERSC account, and follow this tutorial notebook (download link, you can then upload the notebook through the jupyter interface).

  2. Once you can access the catalogs, try to make some plots about things you are interested in. You can find some ideas that have been proposed, but you are more than welcome to come up with new ones!

  3. Now that you are able to make some plots, think about how to "validate" the catalogs (i.e., are there any observation/theory data that can be plotted on the same figure for comparison? How to decide whether a catalog is satisfactory?)

  4. Now we can integrate your work into the DESCQA web interface! This step is slightly more involved, but you can follow the instruction here.

Code structure

  • run_master.sh: a convenient shell script to run DECSQA
  • fix_web_permission.sh: a convenient shell script to ensure permissions are set correctly.
  • index.cgi: CGI script for web interface
  • descqa/: package that contains all the validation test classes and relevant utilities
  • descqa/configs/: directory that hosts all validation test config YAML files
  • descqa/data/: directory that hosts small data files that validation tests need
  • descqaqweb/: package that contains the web interface
  • descqaqrun/: package that contains the execution scripts
  • v1: catalog readers and validation tests for DESCQA v1

Dependencies

See install_requires and extras_require in setup.py for the full installation dependencies.

Note, to run DESCQA (v2), GCRCatalogs is also required.

Additional dependencies For v1

descqa's People

Contributors

yymao avatar evevkovacs avatar tomuram avatar rongpu avatar msimet avatar dkorytov avatar vvinuv avatar adam-broussard avatar pmricker avatar jbkalmbach avatar eiffl avatar ndpadilla avatar morriscb avatar chihway avatar jdcphysics avatar nye17 avatar nsevilla avatar wmwv avatar alekscipri avatar andromedanita avatar patricialarsen avatar duncandc avatar j-dr avatar fjaviersanchez avatar jpratmarti avatar

Watchers

James Cloos avatar

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.