https://github.com/lsst-dm/dmtn-204
Data Annotations in Butler
https://github.com/lsst-dm/dmtn-204
Last synced: 3 months ago
JSON representation
Data Annotations in Butler
- Host: GitHub
- URL: https://github.com/lsst-dm/dmtn-204
- Owner: lsst-dm
- License: cc-by-4.0
- Created: 2021-09-01T20:55:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-10T00:42:30.000Z (almost 2 years ago)
- Last Synced: 2025-01-12T11:17:25.836Z (4 months ago)
- Language: Makefile
- Homepage: https://dmtn-204.lsst.io
- Size: 173 KB
- Stars: 1
- Watchers: 12
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. image:: https://img.shields.io/badge/dmtn--204-lsst.io-brightgreen.svg
:target: https://dmtn-204.lsst.io
.. image:: https://github.com/lsst-dm/dmtn-204/workflows/CI/badge.svg
:target: https://github.com/lsst-dm/dmtn-204/actions/
..
Uncomment this section and modify the DOI strings to include a Zenodo DOI badge in the README
.. image:: https://zenodo.org/badge/doi/10.5281/zenodo.#####.svg
:target: http://dx.doi.org/10.5281/zenodo.#####
##########################
Data Annotations in Butler
##########################
DMTN-204
========
In this document we explore the options for allowing annotations of datasets and dimension records within butler registry. These may be associating standard flags with a dataset or a textual annotation.
**Links:**
- Publication URL: https://dmtn-204.lsst.io
- Alternative editions: https://dmtn-204.lsst.io/v
- GitHub repository: https://github.com/lsst-dm/dmtn-204
- Build system: https://github.com/lsst-dm/dmtn-204/actions/
Build this technical note
=========================
You can clone this repository and build the technote locally with `Sphinx`_:
.. code-block:: bash
git clone https://github.com/lsst-dm/dmtn-204
cd dmtn-204
pip install -r requirements.txt
make html
.. note::
In a Conda_ environment, ``pip install -r requirements.txt`` doesn't work as expected.
Instead, ``pip`` install the packages listed in ``requirements.txt`` individually.
The built technote is located at ``_build/html/index.html``.
Editing this technical note
===========================
You can edit the ``index.rst`` file, which is a reStructuredText document.
The `DM reStructuredText Style Guide`_ is a good resource for how we write reStructuredText.
Remember that images and other types of assets should be stored in the ``_static/`` directory of this repository.
See ``_static/README.rst`` for more information.
The published technote at https://dmtn-204.lsst.io will be automatically rebuilt whenever you push your changes to the ``master`` branch on `GitHub `_.
Updating metadata
=================
This technote's metadata is maintained in ``metadata.yaml``.
In this metadata you can edit the technote's title, authors, publication date, etc..
``metadata.yaml`` is self-documenting with inline comments.
Using the bibliographies
========================
The bibliography files in ``lsstbib/`` are copies from `lsst-texmf`_.
You can update them to the current `lsst-texmf`_ versions with::
make refresh-bib
Add new bibliography items to the ``local.bib`` file in the root directory (and later add them to `lsst-texmf`_).
.. _Sphinx: http://sphinx-doc.org
.. _DM reStructuredText Style Guide: https://developer.lsst.io/restructuredtext/style.html
.. _this repo: ./index.rst
.. _Conda: http://conda.pydata.org/docs/
.. _lsst-texmf: https://lsst-texmf.lsst.io