.. role:: red .. role:: blue .. role:: navy Copyright ========= :navy:`citation.doi` ~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **citation.doi** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | full url of the doi number | http://doi.### | | | | | | **Type**: pydantic.networks.HttpUrl | str | | | | | None | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`citation.authors` ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **citation.authors** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | author names | M.Tee A. Roura | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`citation.title` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **citation.title** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Full title of the citation | Paper Title | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`citation.year` ~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **citation.year** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Year of citation | 2020 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`citation.volume` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **citation.volume** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Journal volume of the citation | 12 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`citation.pages` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **citation.pages** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Page numbers of the citation | 10-15 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`citation.journal` ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **citation.journal** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Journal title of citation | Journal of | | | | Geophysical | | **Type**: str | None | | Research | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`citation.survey_d_o_i` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **citation.survey_d_o_i** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | doi number of the survey | ###/### | | | | | | **Type**: pydantic.networks.HttpUrl | str | | | | | None | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`selected_publications` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **selected_publications** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Any publications that use this data | my paper | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`release_status` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **release_status** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | the release status of the data | Unrestricted | | | | release | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`conditions_of_use` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **conditions_of_use** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Any notes on conditions of use | Cite data upon | | | | usage. | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`acknowledgement` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **acknowledgement** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | any acknowledgments the transfer function | This project | | | should have. | was funded by | | **Type**: str | None | | x. | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`additional_info` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **additional_info** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | any additional information about the data. | This purpose of| | | | this project is| | **Type**: str | None | | ... | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+