.. image:: logo.png
    :alt: GRACE-HPC Logo
    :align: center



Welcome to the documentation for GRACE-HPC!
===========================================

Green Resource for Assessing Carbon & Energy in HPC
---------------------------------------------------

GRACE-HPC is a Python toolkit for estimating the energy consumption and carbon emissions of SLURM-based HPC jobs. 
Calculate your computational carbon footprint through a CLI, Python functions, and an interactive Jupyter Notebook interface.

- **GitHub:** `<https://github.com/Elliot-Ayliffe/GRACE-HPC>`_
- **Python Versions:** 3.11, 3.12
- **Open Source**: MIT License
- **Issues:** `<https://github.com/Elliot-Ayliffe/GRACE-HPC/issues>`_
- **Contact:** elliot.ayliffe@gmail.com 

.. toctree::
   :caption: Background:
   :maxdepth: 2

   introduction
   features
   methodology

.. toctree::
   :maxdepth: 2
   :caption: User Guide:

   installation
   configuration
   inputs_outputs
   cli
   function
   jupyter
   api
   
.. toctree::
   :maxdepth: 2
   :caption: Help:

   faqs