# Installation

The X-ray database is held in the SQLite3 file `xraydb.sqlite`. If you are looking for direct use with SQLite, you can download this from here: xraydb.sqlite.

To install the XrayDB Python module (which includes the sqlite database), use:

    pip install xraydb

Depending on your system and Python installation, you may need administrative privileges or to use sudo to install to a system-installed Python environment.

Note

The Python module supports Python 3.8 and above.

## Development Version

To work with the data sources or to add or modify data in the XrayDB, you will want to clone or download the full source code kit xrayDB on github.com which contains the current database, original source data, python module, and files for generating the Periodic Table posters. To get the latest development version, use:

    git clone https://github.com/xraypy/XrayDB.git

## Testing

There are a set of tests scripts for the Python interface that can be run with the pytest testing framework. These are located in the `python/tests` folder. These tests are automatically run as part of the development process. For any release or any master branch from the git repository, running `pytest` should run all of these tests to completion without errors or failures.

## Copyright, Licensing, and Re-distribution

    Public Domain

    The original sources of the data included here are mostly based on published
    works with the clear intent of providing data to the general public.  Some of
    the datasets here do not have clear statements of copyright or license, but
    have been freely available for many years. The work here is a compilation and
    reformatting of those datasets.

    To the extent possible, and unless otherwise stated, the database files, data
    sources, and documentation files here are placed in the public domain, using
    the Creative Commons 1.0 Universal (CC0 1.0) Public Domain Dedication below.

    In particular, the files named "xraydb.sqlite", "xraydb.schema", and all files
    in the following folders and subfolders:
      data_sources/
      poster/
      doc/

    are all placed in the "Public Domain" using the CC0 1.0 dedication.

    The files in the folder 'python/xraydb' are copyrighted by the lead authors and
    copyrighted using an MIT License, which allows for distribution and re-use of
    the source code with the only restriction being to not remove the notice of
    copyright.  Each of these files will have an explicit notice of copyright and
    license for use.  For files that do not explicitly carry a notice copyrighted,
    no claim of copyright is made and the CC0 1.0 dedication applies.

    The Creative Commons 1.0 Universal (CC0 1.0) Public Domain Dedication
    (https://creativecommons.org/publicdomain/zero/1.0/):

       The person who associated a work with this deed has dedicated the work to
       the public domain by waiving all of his or her rights to the work worldwide
       under copyright law, including all related and neighboring rights, to the
       extent allowed by law.

       You can copy, modify, distribute and perform the work, even for commercial
       purposes, all without asking permission. See Other Information below.

       In no way are the patent or trademark rights of any person affected by CC0,
       nor are the rights that other persons may have in the work or in how the
       work is used, such as publicity or privacy rights.

       Unless expressly stated otherwise, the person who associated a work with
       this deed makes no warranties about the work, and disclaims liability for
       all uses of the work, to the fullest extent permitted by applicable law.

       When using or citing the work, you should not imply endorsement by the
       author or the affirmer.