Skip to content

SalishSeaCast/SalishSeaCmd

Repository files navigation

SalishSeaCast NEMO Command Processor

Continuous Integration Pytest with Coverage Status Codecov Testing Coverage Report CodeQL analysis
Documentation Documentation Status Sphinx linkcheck
Package Releases Python Version from PEP 621 TOML Issue Tracker
Meta Licensed under the Apache License, Version 2.0 Git on GitHub pre-commit The uncompromising Python code formatter Hatch project

The SalishSeaCast NEMO command processor, salishsea, is a command line tool for doing various operations associated with the SalishSeaCast NEMO model.

Use salishsea --help to get a list of the sub-commands available for doing things with and related to SalishSeaCast NEMO. Use salishsea help <sub-command> to get a synopsis of what a sub-command does, what its required arguments are, and what options are available to control it.

Documentation for the command processor is in the docs/ directory and is rendered at https://salishseacmd.readthedocs.io/en/latest/.

Documentation Status

This an extensible tool built on the OpenStack cliff (Command Line Interface Formulation Framework) package. It is a NEMO domain-specific command processor tool for the SalishSeaCast NEMO model that uses plug-ins from the NEMO-Cmd package.

License

Licensed under the Apache License, Version 2.0

The SalishSeaCast NEMO command processor and documentation are copyright 2013 – present by the SalishSeaCast Project Contributors and The University of British Columbia.

They are licensed under the Apache License, Version 2.0. https://www.apache.org/licenses/LICENSE-2.0 Please see the LICENSE file for details of the license.