How to Submit a Model or Request Help

This documentation provides step-by-step guidance for:
  • Requesting support or reporting issues related to CVM tool usage, installation, or troubleshooting.
  • Submitting a velocity model to the CRESCENT-CVM repository.

1. Requesting General Help or Reporting Issues

If you encounter issues not related to velocity model submissions (e.g., questions about tool usage or installation), please follow these steps:

Step 1: Check Existing Documentation

  • CVM Tools Book: Review the CVM Tools Book for comprehensive guidance.
  • GitHub Issues: Search through previously closed issues on GitHub to see if your question has already been addressed.
  • View Closed Issues

Step 2: Create a Help Request on GitHub

  • Navigate to the Issue Page: Visit the CRESCENT-CVM GitHub Issue Page.
  • Open a New Issue: Use a descriptive title (e.g., “Installation Error: CVM Tool”) and include:
    • Detailed error messages
    • System setup information
    • Steps you’ve already taken

Step 3: Engage with the Community

  • For more general or exploratory questions, consider starting a discussion in the GitHub Discussions section to gain broader input from the community.

2. Submitting a Velocity Model

Researchers looking to contribute a velocity model to the repository should follow this process:

Step 1: Review Guidelines

  • Review Guidelines: Visit the CVM Model Contribution Guidelines for detailed instructions.
  • Prepare Your Model:
    • Convert your model from CSV to netCDF4 or HDF5 format.
    • Refer to the sample model files in the sample-files folder of the cvm-tools GitHub repository to understand the required CSV format.
    • Validate your model file using cvm-tools prior to submission.

Step 2: Create a Submission Request on GitHub

  • Open a New Issue:: Go to the CRESCENT-CVM GitHub Issue Page.
  • Title Your Issue: Use the format “Velocity Model Submission: [Your Model Name]”.
  • Describe Your Model: Provide a brief description of your model along with its intended use. Refer to the sample-files folder in the cvm-tools repository for examples of metadata descriptions.

Step 3: Provide a Download Link

  • Public Access Requirement: Include a publicly accessible download link (e.g., Zenodo, Google Drive, or another repository).
  • File Attachments: Do not attach model files directly to the GitHub issue.

Need Further Assistance?

If you are unsure about where to direct your question or need additional help, feel free to start a GitHub issue. Our team will guide you to the correct resources or community discussions.