access-profiling

About

A Python package providing various tools and utilities to profile the models developed at ACCESS-NRI.

Key Features

• Parsers to extract profiling data from model output.
• Functions to plot key profiling metrics.

Documentation

Coming soon.

Installation

Using pip

You can install the latest release directly from PyPI:

pip install access-profiling

From source

If you prefer to install from source:

git clone https://github.com/ACCESS-NRI/access-profiling.git
cd access-profiling
pip install .

Usage

Coming soon.

Development installation

If you intend to contribute or modify the package, it is recommended to work inside a virtual environment.

1. Create and activate a virtual environment

# Create a virtual environment
python3 -m venv .venv

# Activate the virtual environment
source .venv/bin/activate

2. Install in editable mode with development and test dependencies

pip install -e ".[devel,test]"

This will install the package in editable mode, meaning changes to the source code are reflected immediately without reinstallation. Development dependencies such as testing tools will also be installed.

3. Run the test suite

pytest

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you’d like to add features, fix bugs, or improve documentation.

For significant contributions, we recommend discussing proposed changes in an issue before opening a pull request.

License

This project is licensed under the Apache 2.0 License.