Skip to main content

LIGO/Virgo/KAGRA Follow-up Advocate Tools

Project description

LIGO Follow-up Advocate Tools

This package provides tools for LIGO/Virgo/KAGRA follow-up advocates to assist in tasks such as drafting astronomical bulletins for gravitational-wave detections.

To install

The easiest way to install ligo-followup-advocate, is with pip:

pip install --user ligo-followup-advocate

To upgrade

Once you have installed the package, to check for and install updates, run the following command:

pip install --user --upgrade ligo-followup-advocate

Current templates

If you wish to just see examples of the current templates or submit these to be reviewed in P&P, you can find them here.

Example

ligo-followup-advocate provides a single command to draft a GCN Circular skeleton. Pass it the authors and the GraceDB ID as follows:

ligo-followup-advocate compose \
    'A. Einstein (IAS)' 'S. Hawking (Cambridge)' \
    'I. Newton (Cambridge)' 'Data (Starfleet)' \
    'S190407w'

Optionally, you can have the program open the draft in your default mail client by passing it the --mailto option.

For a list of other supported commands, run:

ligo-followup-advocate --help

For further options for composing circulars, run:

ligo-followup-advocate compose --help

You can also invoke most functions directly from a Python interpreter, like this:

>>> from ligo import followup_advocate
>>> text = followup_advocate.compose('S190407w')

To develop

To participate in development, clone the git repository:

git clone git@git.ligo.org:emfollow/ligo-followup-advocate.git

To release

The project is set up so that releases are automatically uploaded to PyPI whenever a tag is created. Use the following steps to issue a release. In the example below, we are assuming that the current version is 0.0.5, and that we are releasing version 0.0.6.

  1. Check the latest pipeline status to make sure that the master branch builds without any errors.

  2. Make sure that all significant changes since the last release are documented in CHANGES.md.

  3. Update the heading for the current release in CHANGES.md from 0.0.6 (unreleased) to 0.0.6 (YYYY-MM-DD) where YYYY-MM-DD is today's date. Also update the version in pyproject.toml similarly.

  4. Update the PDF templates with this new version.

  5. Commit those changes:

    git commit -m "Update changelog for version 0.0.6"
    
  6. Tag the release:

    git tag v0.0.6 -m "Version 0.0.6"
    
  7. Add a new section to CHANGES.md like this:

    ## 0.0.7 (unreleased)
    
    - No changes yet.
    
  8. Commit the changes:

    git commit -m "Back to development"
    
  9. Push everything to GitLab:

     git push --tags
     git push -f
    

    Within a few minutes, the new package will be built and uploaded to PyPI.

  10. Create an SCCB ticket. Note that there is an option to do this via the a button in the CI/CD pipeline, but this template could be outdated. The recommendation is to create the ticket by hand via the above link.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ligo_followup_advocate-1.2.11.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

ligo_followup_advocate-1.2.11-py3-none-any.whl (2.1 MB view details)

Uploaded Python 3

File details

Details for the file ligo_followup_advocate-1.2.11.tar.gz.

File metadata

File hashes

Hashes for ligo_followup_advocate-1.2.11.tar.gz
Algorithm Hash digest
SHA256 ebbf304eb28355209f8c0e680c57cf2541a63772416c224398773c88651a7a2f
MD5 ffe7dfb7a9e6023adc5b9d22d5af4fc5
BLAKE2b-256 0c7ea058c8ce0c513ca7687c7dba8a9b16c2f31b905e83a4636995d59cfc16a5

See more details on using hashes here.

File details

Details for the file ligo_followup_advocate-1.2.11-py3-none-any.whl.

File metadata

File hashes

Hashes for ligo_followup_advocate-1.2.11-py3-none-any.whl
Algorithm Hash digest
SHA256 b2cf89410c90a6da175f84518d987554242cb4ba5515d5306bd1e0f1921822a0
MD5 add3632cfa442aa32a7058e158586508
BLAKE2b-256 86334a1d8be5fa785c91bab38111bad3c8d7046b7f0961477c4f76a56b77fa4b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page