.. Copyright 2021 – present by the Salish Sea Atlantis project contributors,
.. The University of British Columbia, and CSIRO.
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..
..    https://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.

.. SPDX-License-Identifier: Apache-2.0


*************************
AtlantisCmd Documentation
*************************

This is the documentation for the `AtlantisCmd`_ Python package.
This package is developed and tested under Python 3.10.

.. _AtlantisCmd: https://github.com/SS-Atlantis/AtlantisCmd

The `AtlantisCmd`_ package provides the :command:`atlantis` command-line tool for doing various operations associated with the Salish Sea Atlantis project version of the CSIRO Atlantis ecosystem model.

`AtlantisCmd`_ is an extensible tool built on the OpenStack :kbd:`cliff`
(`Command Line Interface Formulation Framework`_)
package.
It is a command processor tool specific to the Salish Sea CSIRO Atlantis model that uses plug-ins from the `NEMO-Cmd`_ package.

.. _Command Line Interface Formulation Framework: https://docs.openstack.org/cliff/latest/
.. _NEMO-Cmd: https://github.com/SalishSeaCast/NEMO-Cmd


.. toctree::
   :maxdepth: 2
   :caption: Contents

   installation/index
   subcommands
   run_description_file/index
   pkg_development

Indices
=======

* :ref:`genindex`
* :ref:`modindex`


License
=======

.. image:: https://img.shields.io/badge/license-Apache%202-cb2533.svg
    :target: https://www.apache.org/licenses/LICENSE-2.0
    :alt: Licensed under the Apache License, Version 2.0

The code and documentation of the Atlantis Command Processor project
are copyright 2021 – present by the Salish Sea Atlantis project contributors, The University of British Columbia, and CSIRO.

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.