Metadata-Version: 2.4
Name: access-profiling
Version: 0.1
Summary: Tools and utilities to profile the ACCESS climate models.
Author-email: Micael Oliveira <micael.oliveira@anu.edu.au>, Manodeep Sinha <manodeep.sinha@anu.edu.au>, Edward Yang <edward.yang@anu.edu.au>
Keywords: profiling,access
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Requires-Python: >=3.11.4
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: xarray
Requires-Dist: pint
Requires-Dist: pint-xarray
Requires-Dist: matplotlib
Requires-Dist: access-config-utils
Requires-Dist: experiment-runner
Requires-Dist: experiment-generator
Requires-Dist: payu
Provides-Extra: devel
Requires-Dist: pre-commit; extra == "devel"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Dynamic: license-file

# access-profiling

![CI](https://github.com/ACCESS-NRI/access-profiling/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/github/ACCESS-NRI/access-profiling/graph/badge.svg?token=KtmrCtSyMv)](https://codecov.io/github/ACCESS-NRI/access-profiling) [![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://opensource.org/license/apache-2-0) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

## About

A Python package providing various tools and utilities to profile the models developed at [ACCESS-NRI](https://github.com/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:
```shell
pip install access-profiling
```

### From source

If you prefer to install from source:
```shell
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
```shell
# 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
```shell
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
```shell
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.
