Skip to content
Snippets Groups Projects

Refactor calc terminology

Closed David Sikter requested to merge refactor-calc-terminology into v1.0.0
58 files
+ 650
670
Compare changes
  • Side-by-side
  • Inline
Files
58
+ 5
5
@@ -399,13 +399,13 @@ it identifies. If something is called a *hash* then it is a hash generated based
entity it identifies. This means either the whole thing or just some properties of
said entities.
- The most common hashes is the `calc_hash` based on mainfile and auxfile contents.
- The most common hashes is the `entry_hash` based on mainfile and auxfile contents.
- The `upload_id` is a UUID assigned to the upload on creation. It never changes.
- The `mainfile` is a path within an upload that points to a file identified as parseable.
This also uniquely identifies an entry within the upload.
- The `entry_id` (`calc_id`) uniquely identifies an entry. It is a hash over the `mainfile`
and respective `upload_id`. **Note**: we want to switch to use `entry_id` and "entry-terminology"
instead of `calc_id` and "calc-terminology". Thus **always use the former if possible**.
- The `entry_id` (previously called `calc_id`) uniquely identifies an entry. It is a hash
over the `mainfile` and respective `upload_id`. **NOTE:** For backward compatibility,
`calc_id` is also still supported in the api, but using it is strongly discouraged.
- We often use pairs of `upload_id/entry_id`, which in many contexts allow to resolve an entry
related file on the filesystem without having to ask a database about it.
- The `pid` or (`coe_calc_id`) is a legacy sequential interger id, previously used to identify
@@ -473,7 +473,7 @@ Keys that are autogenerated for all logs:
Keys that are present for events related to processing an entry:
- `nomad.upload_id`: The id of the currently processed upload
- `nomad.calc_id`: The id of the currently processed entry
- `nomad.entry_id`: The id of the currently processed entry
- `nomad.mainfile`: The mainfile of the currently processed entry
Keys that are present for events related to exceptions:
Loading