https://github.com/lsst-dm/dmtn-227

The Consolidated Database of Image Metadata
https://github.com/lsst-dm/dmtn-227

Last synced: 3 months ago
JSON representation

The Consolidated Database of Image Metadata

• Host: GitHub
• URL: https://github.com/lsst-dm/dmtn-227
• Owner: lsst-dm
• License: cc-by-4.0
• Created: 2022-04-18T19:11:24.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-19T00:49:44.000Z (10 months ago)
• Last Synced: 2025-01-12T11:15:54.472Z (4 months ago)
• Language: Makefile
• Homepage: https://dmtn-227.lsst.io
• Size: 459 KB
• Stars: 1
• Watchers: 10
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://img.shields.io/badge/dmtn--227-lsst.io-brightgreen.svg

   :target: https://dmtn-227.lsst.io/

.. image:: https://github.com/lsst-dm/dmtn-227/workflows/CI/badge.svg

   :target: https://github.com/lsst-dm/dmtn-227/actions/

###########################################

The Consolidated Database of Image Metadata

###########################################

DMTN-227

========

This document proposes a specification for what the content of an image metadata database should be, how it should be managed, how it could be implemented, and how it might be extended.  A phased strategy for bringing it to production is also proposed.

**Links:**

- Publication URL: https://dmtn-227.lsst.io/

- Alternative editions: https://dmtn-227.lsst.io/v

- GitHub repository: https://github.com/lsst-dm/dmtn-227

- Build system: https://github.com/lsst-dm/dmtn-227/actions/

Build this technical note

=========================

You can clone this repository and build the technote locally if your system has Python 3.11 or later:

.. code-block:: bash

   git clone https://github.com/lsst-dm/dmtn-227

   cd dmtn-227

   make init

   make html

Repeat the ``make html`` command to rebuild the technote after making changes.

If you need to delete any intermediate files for a clean build, run ``make clean``.

The built technote is located at ``_build/html/index.html``.

Publishing changes to the web

=============================

This technote is published to https://dmtn-227.lsst.io/ whenever you push changes to the ``main`` branch on GitHub.

When you push changes to a another branch, a preview of the technote is published to https://dmtn-227.lsst.io/v.

Editing this technical note

===========================

The main content of this technote is in ``index.rst`` (a reStructuredText file).

Metadata and configuration is in the ``technote.toml`` file.

For guidance on creating content and information about specifying metadata and configuration, see the Documenteer documentation: https://documenteer.lsst.io/technotes.