https://github.com/lsst/felis
Felis is a tool for collaborative management of astronomical data catalog metadata
https://github.com/lsst/felis
Last synced: 11 months ago
JSON representation
Felis is a tool for collaborative management of astronomical data catalog metadata
- Host: GitHub
- URL: https://github.com/lsst/felis
- Owner: lsst
- License: gpl-3.0
- Created: 2018-10-10T16:50:41.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-07-09T23:41:33.000Z (11 months ago)
- Last Synced: 2025-07-10T03:49:15.823Z (11 months ago)
- Language: Python
- Homepage: https://felis.lsst.io
- Size: 1.64 MB
- Stars: 6
- Watchers: 35
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
Felis
=====
|Tag| |PyPI| |Python| |Codecov|
.. |PyPI| image:: https://img.shields.io/pypi/v/lsst-felis
:target: https://pypi.org/project/lsst-felis
:alt: PyPI
.. |Python| image:: https://img.shields.io/pypi/pyversions/lsst-felis
:target: https://pypi.org/project/lsst-felis
:alt: PyPI - Python Version
.. |Codecov| image:: https://codecov.io/gh/lsst/felis/branch/main/graph/badge.svg
:target: https://codecov.io/gh/lsst/felis
:alt: Codecov
.. |Tag| image:: https://img.shields.io/github/v/tag/lsst/felis
:target: https://github.com/lsst/felis/tags
:alt: Latest Tag
Overview
--------
Felis implements a `YAML `_ data format for describing
database schemas in a way that is independent of implementation
language and database variant. These schema definitions can be checked for
validity using an internal `Pydantic `_ data
model to ensure strict conformance to the format. SQL Data Definition language
(DDL) statements can be generated to instantiate corresponding database
objects, such as tables and columns, in a number of different database
variants, including MySQL, PostgreSQL, and SQLite. The schema can also
be used to update the TAP schema information in a
`TAP `_ service.
The tool was developed internally by the
`Vera C. Rubin Observatory `_ as a way of
defining a "single source of truth" for database schemas and their metadata
which are maintained for the facility in the
`sdm_schemas github repository `_. Though
developed in the context of astronomical data management and including some
optional features that are specific to
`IVOA standards `_, Felis is generic enough
that it can be used as a general tool to define, update, and manage database
schemas in a way that is independent of database variant or implementation
language such as SQL.
Documentation
-------------
Detailed information on usage, customization, and design is available at the
`Felis documentation site `_.
Support
-------
Users may report issues or request features on the `Rubin Community Forum `_ or by opening an issue on the
`Felis Issue Tracker `_. Posts on the
forum should include the tag "felis."
Code of Conduct
---------------
Please see the
`LSST Project Code of Conduct `_ for
guidelines on communications and interactions.
License
-------
Felis is distributed under the
`GNU General Public License
`_, version 3.0 or later.