Skip to content

Home

Jump to bottom
yuanyuanzhang edited this page Jan 16, 2020 · 15 revisions

y3_cluster_cpp wiki

** This page contains information on how to get started on using/contributing to the project. **

** After reading through the page, you'd probably be interested in the rest of the wiki pages, which are listed here https://bitbucket.org/mpaterno/y3_cluster_cpp/wiki/browse/ **

Getting started on DES Y3 CosmoSIS cluster pipeline development.

These are the documents to start with if you are interested in joining the efforts.

To contribute to this project:

  • You may wish to subscribe to a mailing list des-cosmosis-y3@fnal.gov.

  • There is also a DES slack channel (#cosmo_clpipe), but please note that we communicate mainly through the mailing list. Weekly hack reminders are sent to the mailing list.

  • Request access to the repo by sending your bitbucket user name to Yuanyuan (ynzhang@fnal.gov) https://bitbucket.org/mpaterno/y3_cluster_cpp/ (We need to keep the repo private for a bit.)

  • We'd appreciate that you have went through the installation process.

Development Philosphy

We welcome people's contributions to this project. We strive to build elegant, robust and optimized code for Y3 in c++. When you commit your changes, please check the following:

  • The code runs and passes all the tests with your modification. Please don't commit any changes that breaks the code.

  • The code runs in a reasonable time.If your modification slows down the integrand by more than 2 second, you should talk to the team before committing (so we know to look into it for optimization)

  • The code should have been tested a bit, and please consider setting up a unit test.

Installing the software

More information, installation instructions as well as usage tutorial, please see the wiki page. https://bitbucket.org/mpaterno/y3_cluster_cpp/wiki/browse/

The docker installation is a pre-requisite -- unfortunately this is a commercially/community offered software, so we may not be able to help as much -- However, we expect the installation to be trivial for Mac and Ubuntu. If you use other operating systems, you may consider using a Ubuntu virtual machine for installation. Note that docker more or less can only be installed on a machine that you have root access to (like your laptop), and the docker images can't be ran from an external hard disk. After installing docker, there are several repos to clone and install, please follow the instructions on the bitbucket instruction page. This takes some downloading time but should be relatively straightforward.

Clone this wiki locally