Skip to main content

AiiDA Transport/Scheduler plugins for interfacing with FirecREST.

Project description

aiida-firecrest [IN-DEVELOPMENT]

AiiDA Transport/Scheduler plugins for interfacing with FirecREST


(pip not yet available)

pip install aiida-firecrest

Or for development:

git clone
cd aiida-firecrest
pip install -e .

CLI Usage

$ aiida-firecrest-cli --help
Usage: aiida-firecrest-cli [OPTIONS] COMMAND [ARGS]...

  FireCrest CLI.

  --config PATH  Path to the connection file (default: .firecrest-
  --help         Show this message and exit.

  fs      File system operations.
  slurm   Slurm operations.
  stat    Status operations.

The configuration file should look like this:

    "url": "",
    "token_uri": "",
    "client_id": "username-client",
    "client_secret": "xyz",
    "machine": "daint",
    "scratch_path": "/scratch/snx3000/username"

scratch_path is optional. If specified, all operations will be relative to this path.

$ aiida-firecrest-cli stat
Usage: aiida-firecrest-cli stat [OPTIONS] COMMAND [ARGS]...

  Status operations.

  --help  Show this message and exit.

  parameters  Get parameters that can be configured in environment files.
  service     Information about a service.
  services    List available services.
  system      Information about a system.
  systems     List available systems.
$ aiida-firecrest-cli fs
Usage: aiida-firecrest-cli fs [OPTIONS] COMMAND [ARGS]...

  File system operations.

  --help  Show this message and exit.

  cat      Get the contents of a file.
  chmod    Change the mode of a file.
  cwd      Get the current working directory.
  ls       List files in a path.
  putfile  Upload file to the remote.
  stat     Get information about a file.
$ aiida-firecrest-cli slurm
Usage: aiida-firecrest-cli slurm [OPTIONS] COMMAND [ARGS]...

  Slurm operations.

  --help  Show this message and exit.

  sacct   Retrieve information for all jobs.
  squeue  Retrieves information for queued jobs.
  submit  Submit a job script.

Code Style

To format the code and lint it, run pre-commit:

pre-commit run --all-files


It is recommended to run the tests via tox.


By default, the tests are run using a mock FirecREST server (in a temporary folder). You can also provide connections details to a real FirecREST server:

tox -- --firecrest-config=".firecrest-config.json"

The format of the .firecrest-config.json file is:

    "url": "",
    "token_uri": "",
    "client_id": "username-client",
    "client_secret": "xyz",
    "machine": "daint",
    "scratch_path": "/scratch/snx3000/username"

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiida_firecrest-0.1.0a1.tar.gz (11.5 kB view hashes)

Uploaded source

Built Distribution

aiida_firecrest-0.1.0a1-py3-none-any.whl (10.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page