Skip to content

UQ-RCC/nimrodg

Repository files navigation

Nimrod/G

Usage

The CLI is huge, consider use the -h flag.

usage: nimrod [-h] [-c CONFIG] [-d] command ...

Invoke Nimrod/G CLI commands

optional arguments:
  -h, --help             show this help message and exit
  -c CONFIG, --config CONFIG
                         Path to configuration file. (default: /home/user/.config/nimrod/nimrod.ini)
  -d, --debug            Enable debug output. (default: false)

valid commands:
  command
    property             Property Operations.
    experiment           Experiment Operations.
    master               Start the experiment master.
    resource             Resource operations.
    resource-type        Resource type operations.
    job                  Job operations.
    setup                Nimrod/G setup functionality.
    compile              Compile a planfile.
    genconfig            Generate a default configuration file.
    agent                Agent Operations.
    staging              Execute staging commands.

Build Instructions

Use the nimw.sh wrapper script to invoke the CLI via Gradle.

To generate a tarball, use gradle nimrod:assembleDist.

Requirements

  • Java 11+
  • Gradle 5.3.1+

Installation

  • Create a nimrod.ini configuration file in ~/.config/nimrod
    • A sample is provided in nimrodg-cli/src/main/resources
  • Create a setup configuration file. This can be placed anywhere.
    • A sample is provided in nimrodg-cli/src/main/resources
  • Run nimrod setup init /path/to/setup-config.ini
  • You're ready to go.

License

This project is licensed under the Apache License, Version 2.0:

Copyright © 2019 The University of Queensland

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

http://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.

3rd-party Licenses

Project License License URL
Antlr4 The BSD License http://www.antlr.org/license.html
icu4j Unicode/ICU License http://source.icu-project.org/repos/icu/trunk/icu4j/main/shared/licenses/LICENSE
PgJDBC BSD-2-Clause License https://jdbc.postgresql.org/about/license.html
[ini4j] Apache 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
Bouncy Castle Crypto APIs Bouncy Castle License https://www.bouncycastle.org/license.html
Jersey CDDL 1.1 https://jersey.github.io/license.html
sqlite-jdbc Apache 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
RabbitMQ Java Client Library Apache 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
Apache log4j2 Apache 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
Apache Commons CSV Apache 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
Apache Commons IO Apache 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
Apache Commons Collections Apache 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
Apache Tomcat Apache 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
Apache Mina SSHD Apache 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
java_text_tables MIT License https://raw.githubusercontent.com/iNamik/java_text_tables/master/LICENSE.txt