ceos-ard-cli 0.5.2

CLI tools for CEOS-ARD to generate and validate PFS documents

CEOS-ARD CLI

CLI for working with the CEOS-ARD building blocks and PFSes.

• Getting Started
  • Installation
  • Run the CLI
• Commands
  • ceos-ard compile: Compile PFS document to a Markdown file
  • ceos-ard generate: Create Word/HTML/PDF documents for a single PFS
  • ceos-ard generate-all: Create Word/HTML/PDF documents for all PFSes
  • ceos-ard validate: Validate CEOS-ARD components
• Development

Getting Started

In order to make working with CEOS-ARD easier we have developed command-line interface (CLI) tools.

[!TIP] Most people won't need to install this tool. Instead, you can use the CEOS-ARD Editor to edit and/or generate the CEOS-ARD PFS documents.

Installation

Pixi is a modern package management tool that handles both conda and PyPI dependencies.

1. Install Pixi by following the installation instructions (don't follow the "Get Started" instructions, you only need to run the single command provided in the "Installation" section).
2. Clone this repository and the ceos-ard repository:
   • git clone https://github.com/ceos-org/ceos-ard
   • git clone https://github.com/ceos-org/ceos-ard-cli
3. Navigate to the directory: cd ceos-ard-cli
4. Install dependencies: pixi install
5. Install browser for PDF rendering: pixi run install-browser

Run the CLI

1. Run pixi shell
2. Switch into the folder that contains the contents of the ceos-ard repository: cd ../ceos-ard
3. Run ceos-ard with the command you want to execute, e.g. ceos-ard generate-all -o build

See the available commands for further details.

Commands

ceos-ard compile: Compile PFS document to a Markdown file

To compile a PFS document to a Markdown file, run:

• With Pixi: ceos-ard compile SR
• With traditional setup: ceos-ard compile SR

The last part is the PFS to create, e.g. SR or NRB.

Check ceos-ard compile --help (or ceos-ard compile --help) for more details.

ceos-ard generate: Create Word/HTML/PDF documents for a single PFS

To create the Word, HTML, and PDF versions of a single PFS, run:

• With Pixi: ceos-ard generate SR
• With traditional setup: ceos-ard generate SR

The last part is the PFS to create, e.g. SR or NRB.

To create a combined PFS, e.g. SAR, the following command can be used: ceos-ard generate NRB POL ORB GSLC -o ../ceos-ard/build/Combined-SAR -i ../ceos-ard --docx --title="Combined Synthetic Aperture Radar" --pfs-type="SAR" --id="SAR"

Check ceos-ard generate --help (or ceos-ard generate --help) for more details.

ceos-ard generate-all: Create Word/HTML/PDF documents for all PFSes

To create the Word, HTML, and PDF versions for all PFSes, run:

• With Pixi: ceos-ard generate-all
• With traditional setup: ceos-ard generate-all

Check ceos-ard generate-all --help (or ceos-ard generate-all --help) for more details.

ceos-ard validate: Validate CEOS-ARD components

To validate (most of) the building blocks, run:

• With Pixi: ceos-ard validate
• With traditional setup: ceos-ard validate

Check ceos-ard validate --help (or ceos-ard validate --help) for more details.

Development

1. Fork this repository if you plan to change the code or create pull requests.
2. Clone either your forked repository or this repository, e.g. git clone https://github.com/ceos-org/ceos-ard-cli
3. Switch into the newly created folder: cd ceos-ard-cli
4. Follow the Installation instructions above
5. Install dependencies and set up the development environment: pixi run -e dev install-dev
6. Switch into the development envionment: pixi shell -e dev
7. You can now run the CLI in development mode as normal.
8. Run the checks (lint, format, tests) through pixi run check-all
9. Optionally, you can install pre-commit hooks (pre-commit install) to run lint and format automatically for each commit.