You can use the various tabs in our search interface to display statistics. E.g. to see the amount of provided entries over time, or data per code. The numbers are number of entries (essentially number of code runs). You can change the metric with the dropdown right side on top of the search bar. Be aware that the numbers include large imports from external databases like AFLOW, OQMD, Materials Project.
- upload your data
- publish your data
- create a dataset and assign a DOI
- cite your data using a DOI or share URLs for datasets or individual entries
Ultimately. NOMAD is a platform to share data, but we recognize that you might not want to share all data right away. There are two mechanisms to hide data for two different underlying motivations.
First, not yet published data has restricted visibility. Once uploaded, data is only shown to you. Only after you publish your upload, it is visible to others. This allows you to delete wrongly uploaded or processed data privately before publishing anything.
Second, you can publish your uploads with an embargo period. This can last up to 3 years. You can lift the embargo at any time. Embargoed data is visible to and findable by others. This makes only some few metadata (e.g. chemical formula, system type, spacegroup, etc.) public, but the raw-file and archive contents remain hidden (except to you, and users you explicitly share the data with). You can already create datasets and assign DOIs for data with embargo, e.g. to put it into your unpublished paper. The embargo will last up to 36 months. Afterwards, your data will be made publicly available. You can also lift the embargo on entries at any time.
You can copy links from your browsers URL-field and send it to others. But, not all users might see the same; you have to be aware when and to own your data might be visible.
If you published your data without embargo, everybody will be able to see your data through our search, e.g. with "authors=Markus Scheidgen": https://nomad-lab.eu/prod/rae/gui/search?authors=Markus%20Scheidgen
If you published your data with embargo, you need to set your co-authors also to "Shared with" in the edit dialog. Data is not shared with co-authors by default. Anybody in "Shared with" can access your data on their "Your data" page with activated "Shared" checkbox when logged in: https://nomad-lab.eu/prod/rae/gui/userdata?owner=shared&results=entries.
Or, on our search with activated "Include private" checkbox and searching for you as author: https://nomad-lab.eu/prod/rae/gui/search?authors=Markus%20Scheidgen&owner=visible.
If you created a dataset and share the dataset link, the entries are visible to everyone, but only you and "Shared with" user will be able to download your files and see the archives. This would allow reviewers to see a little bit of your data (the metadata), if you put this link or a potential DOI in a paper under review. https://nomad-lab.eu/prod/rae/gui/dataset/id/itY1yB8STTKv_-sWSRaRcQ.
The upload page, is only for you to manage your uploads and not visible by others. In contrast to the entries (i.e. calculations) that can be shared, the upload its self, only belongs to you.
- We offer a proprietary NOMAD API that supports all of NOMAD's functions. This is also used by NOMAD web-interface, example notebooks and Python scripts.
- NOMAD also implements the standardized OPTIMADE API.
- There is also simple semantic-web API based on the W3C DCAT vocabulary.
NOMAD offers several REST API endpoints to access the various aspects of NOMAD (api/archive, api/repo, api/raw). Furthermore, you can use our NOMAD Archive client library to access the archive. With all these options, you can give search criteria that are used determine the set of results and this result set can be arbitrarily large. Therefore, multiple requests have to be used to retrieve all results where each requests asks for a certain "page" of the results. In principle there are several pagination mechanisms that the various endpoints/libraries might support.
- Pagination based on page numbers, e.g. "give me page n with m elements". This type of pagination is limited due to our underlying search engine (Elasticsearch) inner workings to the first 10.000 results.
- Pagination based on a scroll window. Here the server will provide you a scroll id that when used in subsequent requests, will yield the next m results.
- Pagination based on an after value. This is what the NOMAD Archive client library uses internally to provide large result sets. The response contains the next m results that come directly after the given value; each response provides the next after value, i.e. its last value. This is based on Elasticsearch aggregations: The NOMAD Archive client library for examples aggregates calculations within their uploads. The after values are "<upload_id>:<calc_id>"
The pagination options can severely limit the parallel access of NOMAD. Scrolling only works sequentially or you depend on after values from a previous request. However, it might be possible for you to determine after values (e.g. upload ids) in advance and therefore parallelize request based on after value pagination.
Besides unforeseen issue with our services, this most likely means that you exceeded a rate-limit. The amount of requests that you can make might be limited. Please consider to lower the amount of requests per second with which you use NOMAD APIs.
Rate-limits are a precautionary measure against abuse. Please contact us, if you feel that the rate-limit is too low to perform your legitimate application or if you want to get exempted from the rate-limit.