New package: ClimaOceanCalibration v0.1.0

[JuliaRegistrator]

• Registering package: ClimaOceanCalibration
• Repository: https://github.com/CliMA/ClimaOceanCalibration.jl
• Created by: @xkykai
• Version: v0.1.0
• Commit: 7c3743c97783f3cf01f97372f7bdcbc9864cc938
• Reviewed by: @xkykai
• Reference: CliMA/ClimaOceanCalibration.jl@7c3743c#commitcomment-166826973
• Description: Calibration of ocean models driven by prescribed atmospheric states.

[github-actions]

Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of AutoMerge guidelines. If all these guidelines are met, this pull request will be merged automatically, completing your registration. It is strongly recommended to follow the guidelines, since otherwise the pull request needs to be manually reviewed and merged by a human.

1. New package registration

Please make sure that you have read the package naming guidelines.

2. AutoMerge Guidelines which are not met ❌

• There is no compat entry for julia.
• I was not able to install the package (i.e. Pkg.add("ClimaOceanCalibration") failed). See the AutoMerge logs for details.
• I was not able to load the package (i.e. import ClimaOceanCalibration failed). See the AutoMerge logs for details.

3. Needs action: here's what to do next

1. Please try to update your package to conform to these guidelines. The General registry's README has an FAQ that can help figure out how to do so.
2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your Project.toml file (unless the AutoMerge issue is that you skipped a version number).

If you need help fixing the AutoMerge issues, or want your pull request to be manually merged instead, please post a comment explaining what you need help with or why you would like this pull request to be manually merged. Then, send a message to the #pkg-registration channel in the public Julia Slack for better visibility.

4. To pause or stop registration

If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text [noblock] in your comment.

Tip: You can edit blocking comments to add [noblock] in order to unblock auto-merging.

[goerz]

Thank you for submitting your package! I would encourage you to add a little bit more documentation before registering. In addition to the description the package's purpose, that would probably a small usage example in the README. I did notice the examples folder, but still: an important part of packages in General is that any potential user can figure out what the package is about and how to get started with using it. That is really difficult when there is basically no documentation.

In the longer term, I definitely recommend setting up a Documenter-based documentation. Before a v1.0 release, or for smaller packages that can be effectively described entirely with their README, that's not a requirement, though.

[noblock]