Help:Best Practices: Difference between revisions

From Ruisdael Observatory Data Catalog
No edit summary
Line 18: Line 18:
For non-stationary in-situ and remote sensing observations, use the description field to indicate the measurement domain. For example, the coordinates from the starting and ending points could be mentioned.
For non-stationary in-situ and remote sensing observations, use the description field to indicate the measurement domain. For example, the coordinates from the starting and ending points could be mentioned.


= Description of different submission types =
= Dataset description field =
Use the description field to provide all import information from the new dataset. While writing the Description, try to indicate the data source, the content, and the goal of the data. Try to provide enough information to help users understand the dataset content without downloading the data. Below, you can find a non-exhaustive checklist for the different data types to be used as a starting point.
Use the description field to provide all important information about the dataset. This includes data source, content, and purpose. Ideally, users should be able to understand what the dataset contains without having to download and inspect the actual data. Below, you can find a non-exhaustive checklist for what to include in your dataset description.


== Checklist for in-situ datasets ==
== Checklist for in-situ datasets ==
*What is the instrument's name?
* instrument name, model and brand
*What is the instrument's model?
* location, site name and geographical description of area
*What is the instrument's Brand?
* spatial and temporal resolution of measurements
*What is the data resolution?
* physical variables contained in the dataset  
*What are the variables listed in the dataset?
* purpose of the dataset
*Where is it installed?
* context of the experiment/measurement
*What is it intended for?
* for non-stationary instruments: latitude, longitude, height from starting and ending point.
*If non-stationary instrument: latitude, longitude, height from starting and ending point.


== Checklist for campaigns and products datasets ==
== Checklist for campaigns and products datasets ==

Revision as of 15:56, 3 April 2025

This page describes best practices for adding new datasets and entering metadata into the catalog. In case you think some information is missing, please indicate it on GitHub Ruisdael Data Catalog project.

General guidelines for all submissions

Naming

The first required field for submitting a new dataset is the name. This name is used to identify the new dataset within the Catalog environment. To name the dataset, please use the following convention: Institute Sensor/Campaign/Product/Model at Location.

 Institute Sensor/Campaign/Product/Model at Location

Examples:

Geographic coordinates

For datasets produced by stationary instruments (in-situ, remote sensing) and for single-column model outputs, the latitude and longitude coordinates should be entered with a precision of at least 4 digits (approx 11 meters). However, the use 5 or 6 significant digits is recommended.

For non-stationary in-situ and remote sensing observations, use the description field to indicate the measurement domain. For example, the coordinates from the starting and ending points could be mentioned.

Dataset description field

Use the description field to provide all important information about the dataset. This includes data source, content, and purpose. Ideally, users should be able to understand what the dataset contains without having to download and inspect the actual data. Below, you can find a non-exhaustive checklist for what to include in your dataset description.

Checklist for in-situ datasets

  • instrument name, model and brand
  • location, site name and geographical description of area
  • spatial and temporal resolution of measurements
  • physical variables contained in the dataset
  • purpose of the dataset
  • context of the experiment/measurement
  • for non-stationary instruments: latitude, longitude, height from starting and ending point.

Checklist for campaigns and products datasets

  • What was the campaign goal?
  • What are the instruments used?
  • What is the duration?
  • What are the variables?
  • What is the data resolution?
  • If it is a data product, how was it derived?
  • If any external link to the data processing is available, it can also be listed here.

Checklist model output submission

  • What model was used?
  • What model version was used, and where can it be found?
  • What was the model configuration?
  • What is the output resolution?
  • Is the output from a single column? So, what are the latitude and longitude coordinates?
  • Is the output from a spatial domain? So, what is the domain?
======================================================

Original Conttent

/This page is under construction. Please come back later..

General Guidelines

  • Latitude and longitude coordinates for in-situ and remote sensing datasets should be entered with a precision of at least 4 digits.
  • Refrain from using Notes. Put important information directly in the description
  • Naming convection for the title: Institute - Sensor - Location

Checklist for in-situ data

  • dataset description should contain sensor type/brand
  • dataset description should contain .. (if applicable)

Checklist for remote-sensing data

Checklist for model data

  • The description should explicitly mention the variables that are provided (e.g., temperature, wind speed, etc..)

Campaign data

How to enter campaign data?