Model Contribution Guidelines
To contribute your Cascadia Earth model to CRESCENT:
Study Area Requirement: The majority of the model must fall within the CRESCENT CVM footprint (latitude: 39° to 52°, longitude: -130° to -116°) or be completely contained in it.
Peer-reviewed: All models must be published in a peer-reviewed paper. Include a publicly accessible download link to the peer-reviewed article describing this model to the submission.
Standards Compliance: All models must adhere to the CVM Standards and Conventions.
Model Preparation: Follow the steps outlined in the How to Prepare Your Model section below.
Submission Request: Visit the CRESCENT-CVM GitHub Issue Page and create a submission request.
Your request must include a download link to your model.
Do not attach model files directly to the issue request.
How to Prepare Your Model¶
To ensure your model complies with CVM standards, please follow the following conversion and validation steps depending on your original model’s data format.
Format Conversion¶
Please Note: CVM follows a specific variable naming convention, as outlined in the Model Variable Naming and Unit Requirements section of Standards and Conventions. Please rename your variables accordingly.
CSV to netCDF4 or HDF5¶
If your original model is in CSV format and you want to convert it to netCDF4, please follow the steps outlined under cvm_writer_3D or cvm_writer_2D for the 3D and 2D models respectively.
If you want to convert your CSV files to HDF5 format, please follow the steps outlined under cvm_writer_h5.
netCDF to CVM-compatible netCDF4¶
If your original model is in a valid netCDF3 or netCDF4 Classic format, please follow the steps under netcdf_to_cvm to ensure that it complies with the CVM standards.
Model File Validation¶
Validating netCDF Files and Creating the metadata JSON file¶
Please verify the netCDF file’s metadata content using cvm_inspector.
Please verify the netCDF file’s metadata and create a slice to validate the file content using cvm_slicer.
Use the netcdf_to_geocsv tool with
-m trueoption to create a JSON file containing your files metadata.
Validating HDF5 Files¶
Please verify their metadata and create a slice to validate the file content using the cvm_slicer_h5 Tool (coming soon).