Git Workflow

If you are not familiar with git, please refer to a tutorial such as this one.

In COMPAS we work in the dev branch, and use the master branch for the major version changes. The main workflow is as follows:

1. Create a git-issue describing the tasks you want to work on (this is optional, but recommended).

2. Create a new branch from dev with a descriptive name (e.g. feature/issue-123), and make a draft pull request to dev. This will allow you to work on the code collaboratively and get feedback from the team.

3. Make your changes, commit them, and push them to the remote repository. Every commit will trigger the continuous integration (CI) tests.

4. Once you are happy with your changes, check that CI tests are passing, and switch the PR to ready for review. This will make it clear to the team that your changes are ready for review.

The team will review your changes, and may ask you to make some modifications. You can make these changes in the same branch, and push them to the remote repository. Once the changes are approved, the PR will be merged into dev.

CI Tests

There are a few tests that are run automatically when you push your changes to the remote repository. These tests are:

1. spell-checking This ensures that docstrings and comments are correctly spelled.

2. COMPAS compile test This ensures that COMPAS C++ and python utilities can be correctly compiled (and COMPAS can run on a fiducial binary system).

3. COMPAS py-utils unit tests This ensures that some of the python utilities are working as expected.

The tests will fail if the fiducial binary system does not lead to a binary black hole merger.

#bin/bash
echo ">>>  GENERATING TEST COMPAS DATA <<<"
# if $COMPAS_EXECUTABLE_PATH not set, set to ../../src/COMPAS
COMPAS_EXECUTABLE_PATH=${COMPAS_EXECUTABLE_PATH:-../../src/COMPAS}
$COMPAS_EXECUTABLE_PATH \
  -n 2 \
  --initial-mass-1 35 \
  --initial-mass-2 31 \
  -a 3.5 \
  --random-seed 0 \
  --metallicity 0.001 \
  --detailed-output \
  > compas_run.log
cat compas_run.log
echo "Generating detailed evolution plot"
compas_plot_detailed_evolution "./COMPAS_Output/Detailed_Output/BSE_Detailed_Output_0.h5" --dont-show >> detailed_evolution.log
echo "Out files:"
ls -l
echo ">>> DONE <<<"