Technical Documentation :: Technical Documentation

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>Technical Documentation :: Technical Documentation</title> <link rel="canonical" href="https://techdocs.gbif.org/en/"> <meta name="generator" content="Antora 3.1.2"> <link rel="stylesheet" href="./_/css/site.css"> <link rel="stylesheet" href="./_/css/special-pages.css"> <script>var uiRootPath = './_'</script> <style type="text/css"> .doc { margin: 5rem auto; max-width: 100rem; } @media screen and (min-width: 1024px) { .doc { max-width: 100rem; } } .doc h2:not(.discrete), .doc h3:not(.discrete) { border-bottom: none; } /* Blocks/tiles in a 3-wide grid. */ .blocks ul, .blocks li, .blocks p { display: block; padding: 0; margin: 0; } .blocks > ul { display: flex; flex-wrap: wrap; align-items: stretch; justify-content: space-between; gap: 1rem 0.5rem; } .blocks > ul > li { display: block; border: 1px solid #f2f2f2; box-shadow: 0 3px 3px #f2f2f2; text-align: center; margin-top: 0.25rem; } @media screen and (min-width: 768px) { .blocks > ul > li { flex-basis: calc(50% - 0.5rem); } } @media screen and (min-width: 1024px) { .blocks > ul > li { flex-basis: calc(33.33% - 0.5rem); } } .doc .blocks > ul > li .image:not(.left):not(.right) > img { margin-top: 0; } .blocks > ul > li ul { margin: 0.75rem; } .doc .ulist.blocks li, .doc .ulist.blocks li + li { margin-top: 0; } /* Short and wide block/tiles in a two-column grid. */ .smallblocks ul, .smallblocks li, .smallblocks p { display: block; padding: 0; margin: 0; } .smallblocks > ul { display: flex; flex-wrap: wrap; align-items: stretch; justify-content: space-between; gap: 0.5rem 1rem; } .smallblocks > ul > li { display: block; flex-basis: calc(50% - 1rem); height: 4rem; background: #f2f2f2; } .doc .smallblocks > ul > li .image:not(.left):not(.right) > img { margin-top: 0; height: 4rem; } .doc .smallblocks > ul > li a { display: block; } .smallblocks > ul > li ul { margin: 0.75rem; } /* A decorative image on the left, a list of three short and wide tiles on the right, each with an icon */ .bannerblocks ul, .bannerblocks li, .bannerblocks p { display: block; padding: 0; margin: 0; } .bannerblocks > .content { display: grid; grid-template-columns: 1fr 1fr; column-gap: 1rem; } .bannerblocks .imageblock, .bannerblocks .ulist { } .bannerblocks .imageblock .content { margin: 0 auto; } .bannerblocks .imageblock img { height: calc(4rem * 3 + 0.75rem * 2); /* 3 tiles + two margins */ } .bannerblocks ul > li { display: block; height: 4rem; background: #f2f2f2; } .doc .bannerblocks ul > li .image:not(.left):not(.right) > img { margin-top: 0; height: 4rem; } .doc .bannerblocks ul > li a { display: block; } .bannerblocks ul > li ul { margin: 0.75rem; } .bannerblocks .bannerblocksmore { grid-column-start: 2; text-align: right; } @media screen and (max-width: 767px) { .bannerblocks > .content { grid-template-columns: 1fr; } .bannerblocks .imageblock { display: none; } .bannerblocks .bannerblocksmore { grid-column-start: 1; } } @media screen and (max-width: 1023px) { .bannerblocks > .content { grid-template-columns: 1fr 2fr; } } </style> </head> <body class="home"> <header class="header"> <nav class="navbar"> <div class="navbar-brand"> <a class="navbar-item" href="https://techdocs.gbif.org/en"> <svg class="logo" viewBox="90 239.1 539.7 523.9" xmlns="http://www.w3.org/2000/svg"> <path class="gbif-logo-svg" d="M325.5,495.4c0-89.7,43.8-167.4,174.2-167.4C499.6,417.9,440.5,495.4,325.5,495.4"></path> <path class="gbif-logo-svg" d="M534.3,731c24.4,0,43.2-3.5,62.4-10.5c0-71-42.4-121.8-117.2-158.4c-57.2-28.7-127.7-43.6-192.1-43.6c28.2-84.6,7.6-189.7-19.7-247.4c-30.3,60.4-49.2,164-20.1,248.3c-57.1,4.2-102.4,29.1-121.6,61.9c-1.4,2.5-4.4,7.8-2.6,8.8c1.4,0.7,3.6-1.5,4.9-2.7c20.6-19.1,47.9-28.4,74.2-28.4c60.7,0,103.4,50.3,133.7,80.5C401.3,704.3,464.8,731.2,534.3,731"></path> </svg> <div class="nav-brand__name-area"> <span>Technical Documentation</span> </div> </a> <button class="navbar-burger" data-target="topbar-nav"> <span></span> <span></span> <span></span> </button> </div> <div id="topbar-nav" class="navbar-menu"> <div class="navbar-end"> </div> <div class="navbar-end"> <div class="navbar-item has-dropdown is-hoverable">  <a class="navbar-link" href="en"> <svg class="navbar-languages" fill="#fcfcfc" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg"> <path d="M0 0h24v24H0z" fill="none"/> <path d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"/> </svg> </a> <div class="navbar-dropdown"> <a class="navbar-item" href="./../en/">English</a>  </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link"> <svg class="navbar-feedback" fill="#fcfcfc" height="24" viewBox="0 0 100 100" width="24" xmlns="http://www.w3.org/2000/svg" > <path d="M15.5,15.498h69v51.754H67.253v17.25L50,67.252H15.5V15.498z"/> </svg> </a> <div class="navbar-dropdown"> <a class="navbar-item" href="https://github.com/gbif/tech-docs/issues/new?labels=Feedback&body=Feedback+on+[Technical Documentation](https://techdocs.gbif.org/en/) ([Github source for this page](../blob/main/./en/home/modules/ROOT/pages/index.adoc))%0A%0AWrite+your+feedback+here.">Leave feedback on GitHub</a> <a class="navbar-item" href="mailto:helpdesk@gbif.org?subject=Feedback on technical documentation 'Technical Documentation'&body=Feedback on https://techdocs.gbif.org/en/">Send feedback by email</a> <a class="navbar-item" href="https://github.com/gbif/tech-docs/edit/main/en/home/modules/ROOT/pages/index.adoc">Edit this page on GitHub</a> </div> </div> </div> </div> </nav> </header> <div class="body"> <main class="article"> <div class="content"> <section class="doc"> <h1 class="page">Technical Documentation</h1> <div id="preamble"> <div class="sectionbody"> <div class="paragraph"> <p>The GBIF technical documentation describes how users can access data from GBIF. It provides information on the available data, how to retrieve it, where it has been cleaned or checked for data quality, and how it should be cited.</p> </div> <div class="paragraph"> <p>Apart from the already available documentation of the GBIF Integrated Publishing Toolkit (IPT), the documentation will later link to additional information for data publishers, including guidelines on best practices for publishing high-quality data, references to the relevant standards, and more detailed information on the data quality checks and alignments made to published data.</p> </div> <div class="paragraph"> <p>Please send any suggestions for improvements or corrections to <a href="mailto:helpdesk@gbif.org">helpdesk@gbif.org</a>, or create an issue on the <a href="https://github.com/gbif/tech-docs/issues">GitHub tech-docs project</a>.</p> </div> </div> </div> <div class="sect1"> <h2 id="what-are-you-looking-for"><a class="anchor" href="#what-are-you-looking-for"></a>What are you looking for?</h2> <div class="sectionbody"> <div id="search-field" class="main-page-search"> <input id="search-input" type="text" placeholder="Search" style="display: block; width: 100%; font-size: 2rem; background: #f2f2f2; padding: 0.25rem 1rem; border: none; margin: 1rem 0;"> </div> <div class="ulist blocks"> <ul> <li> <p><a href="data-use/" class="xref page"><span class="image"><img src="_images/td-bg-01.png" alt="td bg 01"></span></a></p> <div class="ulist"> <ul> <li> <p><a href="data-use/" class="xref page">Using data</a></p> </li> <li> <p>How to use data from GBIF, including <a href="data-use/#data-downloads" class="xref page">downloads</a>, <a href="data-use/rgbif" class="xref page">rgbif</a> and <a href="data-use/pygbif" class="xref page">pygbif</a>.</p> </li> </ul> </div> </li> <li> <p><a href="openapi/" class="xref page"><span class="image"><img src="_images/td-bg-02.png" alt="td bg 02"></span></a></p> <div class="ulist"> <ul> <li> <p><a href="openapi/" class="xref page">API Reference</a></p> </li> <li> <p>Reference information for the GBIF API.</p> </li> </ul> </div> </li> <li> <p><a href="data-processing/" class="xref page"><span class="image"><img src="_images/td-bg-03.png" alt="td bg 03"></span></a></p> <div class="ulist"> <ul> <li> <p><a href="data-processing/" class="xref page">Data processing and quality checks</a></p> </li> <li> <p>The standardization and quality processes applied to data published to GBIF, including taxonomic, temporal and geographic checks.</p> </li> </ul> </div> </li> <li> <p><a href="cloud-services/" class="xref page"><span class="image"><img src="_images/td-bg-04.png" alt="td bg 04"></span></a></p> <div class="ulist"> <ul> <li> <p><a href="cloud-services/" class="xref page">Cloud services</a></p> </li> <li> <p>Accessing GBIF’s data using cloud services (AWS, Azure, GCS).</p> </li> </ul> </div> </li> <li> <p><a href="#data-publishing::index.adoc" class="xref unresolved"><span class="image"><img src="_images/td-bg-05.png" alt="td bg 05"></span></a></p> <div class="ulist"> <ul> <li> <p><a href="#data-publishing::index.adoc" class="xref unresolved">Data Publishing</a></p> </li> <li> <p>Information for new and experienced publishers of data to GBIF</p> </li> </ul> </div> </li> <li> <p><a href="system-components/" class="xref page"><span class="image"><img src="_images/td-bg-06.png" alt="td bg 06"></span></a></p> <div class="ulist"> <ul> <li> <p><a href="system-components/" class="xref page">System components</a></p> </li> <li> <p>Parts of the GBIF system setup (registry, GRSciColl etc)</p> </li> </ul> </div> </li> </ul> </div> </div> </div> <div class="sect1 discrete"> <h2 id="explore-tool-documentation"><a class="anchor" href="#explore-tool-documentation"></a>Explore tool documentation</h2> <div class="sectionbody"> <div class="openblock bannerblocks"> <div class="content"> <div class="imageblock"> <div class="content"> <img src="_images/tools-2.png" alt="tools 2"> </div> </div> <div class="ulist"> <ul> <li> <p><a href="tools/#ipt" class="xref page"><span class="image"><img src="_images/tool-icon.png" alt="tool icon"></span> GBIF Integrated Publishing Toolkit (IPT)</a></p> </li> <li> <p><a href="tools/#data-validator" class="xref page"><span class="image"><img src="_images/tool-icon.png" alt="tool icon"></span> Data validator</a></p> </li> <li> <p><a href="tools/#derived-datasets" class="xref page"><span class="image"><img src="_images/tool-icon.png" alt="tool icon"></span> Derived datasets</a></p> </li> </ul> </div> <div class="paragraph bannerblocksmore blocklink"> <p><a href="tools/" class="xref page">View all tools</a></p> </div> </div> </div> </div> </div> </section> </div> </main> </div> <footer class="footer"> <div class="horizontal-stripe light-background"> <div class="footer-container"> <nav class="site-footer__menu"> <div> <a href="https://www.gbif.org/">GBIF.org</a> <a href="https://data-blog.gbif.org/">Data blog</a> <a href="https://www.gbif.org/terms">Terms and agreements</a> <a href="https://www.gbif.org/contact-us">Contact</a> </div> <div> <strong>GBIF Secretariat</strong> • Universitetsparken 15 • DK-2100 Copenhagen Ø • Denmark </div> </nav> </div> </div> <div class="horizontal-stripe"> <div class="footer-container"> <a href="https://www.gbif.org/"><img src="https://www.gbif.org/img/full_logo_white.svg" alt="GBIF"></a> </div> </div> </footer> <script id="site-script" src="./_/js/site.js" data-ui-root-path="./_"></script> <script async src="./_/js/vendor/highlight.js"></script> <script src="./_/js/vendor/lunr.js"></script> <script src="./_/js/search-ui.js" id="search-ui-script" data-site-root-path="." data-snippet-length="100" data-stylesheet="./_/css/search.css"></script> <script async src="./search-index.js"></script> <script defer data-domain="techdocs.gbif.org" src="https://plausible.io/js/script.file-downloads.js"></script> </body> </html>

CINXE.COM

Technical Documentation :: Technical Documentation