ACCESS Model Output Post-Processor, maps raw model output to CMIP-style defined variables and produce post-processed output using CMOR3
This project has been archived.
The maintainers of this project have marked this project as archived. No new releases are expected.
Project description
ACCESS Model Output Post-Processor (ACCESS-MOPPeR) v2
ACCESS-MOPPeR is a CMORisation tool designed to post-process ACCESS model output and produce CMIP-compliant datasets. This version represents a significant rewrite focusing on usability, flexibility, and integration with modern Python workflows.
Key Features
- Python API for integration into notebooks and scripts
- Batch processing system for HPC environments with PBS
- Real-time monitoring with web-based dashboard
- Flexible CMORisation of individual variables
- Dask-enabled for scalable parallel processing
- Cross-platform compatibility (not limited to NCI Gadi)
- CMIP6 and CMIP7 FastTrack support
Installation
ACCESS-MOPPeR requires Python >= 3.11. Install with:
pip install numpy pandas xarray netCDF4 cftime dask pyyaml tqdm requests streamlit
pip install .
Quick Start
Interactive Usage (Python API)
import glob
from access_mopper import ACCESS_ESM_CMORiser
# Select input files
files = glob.glob("/path/to/model/output/*mon.nc")
# Create CMORiser instance
cmoriser = ACCESS_ESM_CMORiser(
input_paths=files,
compound_name="Amon.pr", # table.variable format
experiment_id="historical",
source_id="ACCESS-ESM1-5",
variant_label="r1i1p1f1",
grid_label="gn",
activity_id="CMIP",
output_path="/path/to/output"
)
# Run CMORisation
cmoriser.run()
cmoriser.write()
Batch Processing (HPC/PBS)
For large-scale processing on HPC systems:
- Create a configuration file (
batch_config.yml):
variables:
- Amon.pr
- Omon.tos
- Amon.ts
experiment_id: piControl
source_id: ACCESS-ESM1-5
variant_label: r1i1p1f1
grid_label: gn
input_folder: "/g/data/project/model/output"
output_folder: "/scratch/project/cmor_output"
file_patterns:
Amon.pr: "output[0-4][0-9][0-9]/atmosphere/netCDF/*mon.nc"
Omon.tos: "output[0-4][0-9][0-9]/ocean/*temp*.nc"
Amon.ts: "output[0-4][0-9][0-9]/atmosphere/netCDF/*mon.nc"
# PBS configuration
queue: normal
cpus_per_node: 16
mem: 32GB
walltime: "02:00:00"
scheduler_options: "#PBS -P your_project"
storage: "gdata/project+scratch/project"
worker_init: |
module load conda
conda activate your_environment
- Submit batch job:
mopper-cmorise batch_config.yml
- Monitor progress at http://localhost:8501
Batch Processing Features
The batch processing system provides:
- Parallel execution: Each variable processed as a separate PBS job
- Real-time monitoring: Web dashboard showing job status and progress
- Automatic tracking: SQLite database maintains job history and status
- Error handling: Failed jobs can be easily identified and resubmitted
- Resource optimization: Configurable CPU, memory, and storage requirements
- Environment management: Automatic setup of conda/module environments
Monitoring Tools
- Streamlit Dashboard: Real-time web interface at http://localhost:8501
- Command line: Use standard PBS commands (
qstat,qdel) - Database: SQLite tracking at
{output_folder}/cmor_tasks.db - Log files: Individual stdout/stderr for each job
File Organization
work_directory/
├── batch_config.yml # Your configuration
├── cmor_job_scripts/ # Generated PBS scripts and logs
│ ├── cmor_Amon_pr.sh # PBS script
│ ├── cmor_Amon_pr.py # Python processing script
│ ├── cmor_Amon_pr.out # Job output
│ └── cmor_Amon_pr.err # Job errors
└── output_folder/
├── cmor_tasks.db # Progress tracking
└── [CMORised files] # Final output
Documentation
- Getting Started:
docs/source/getting_started.rst - Example Configuration:
src/access_mopper/examples/batch_config.yml - API Reference: [Coming soon]
Current Limitations
- Alpha version: Intended for evaluation only
- Ocean variables: Limited support in current release
- Variable mapping: Under review for CMIP6/CMIP7 compliance
Support
- Issues: Submit via GitHub Issues
- Questions: Contact ACCESS-NRI support
- Contributions: Welcome via Pull Requests
License
ACCESS-MOPPeR is licensed under the Apache-2.0 License.
Background: ACCESS-MOPPeR v2 is a complete rewrite using modern Python libraries (xarray, dask) instead of CMOR, providing improved flexibility and integration with contemporary data science workflows.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file access_mopper-2.3.0a24.tar.gz.
File metadata
- Download URL: access_mopper-2.3.0a24.tar.gz
- Upload date:
- Size: 310.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
62b0b80f46e5999da2f24d5f52766bd962488f526420319484eac5339fdcfc88
|
|
| MD5 |
cfd48938355fc218f1b3ddc816aa6a10
|
|
| BLAKE2b-256 |
20a5aac0fa72ea474732d2178c1836dad17b87118861e09d66ef20a672b87bf9
|
Provenance
The following attestation bundles were made for access_mopper-2.3.0a24.tar.gz:
Publisher:
cd.yml on ACCESS-NRI/ACCESS-MOPPeR
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
access_mopper-2.3.0a24.tar.gz -
Subject digest:
62b0b80f46e5999da2f24d5f52766bd962488f526420319484eac5339fdcfc88 - Sigstore transparency entry: 442791280
- Sigstore integration time:
-
Permalink:
ACCESS-NRI/ACCESS-MOPPeR@fc25b24db77b11986c1550ae0aa542583287455b -
Branch / Tag:
refs/tags/v2.3.0a24 - Owner: https://github.com/ACCESS-NRI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
cd.yml@fc25b24db77b11986c1550ae0aa542583287455b -
Trigger Event:
push
-
Statement type:
File details
Details for the file access_mopper-2.3.0a24-py3-none-any.whl.
File metadata
- Download URL: access_mopper-2.3.0a24-py3-none-any.whl
- Upload date:
- Size: 348.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7e5387dd0c906b3d7fe3786bc01a741bc3d5cd8c29a736c78e332e46cac8d55c
|
|
| MD5 |
789d1a36a08eac31fda369d473fded1b
|
|
| BLAKE2b-256 |
a076b26a5aa758219ddf51a90f241b8497adfb841fcbef2605a9850baec0d93e
|
Provenance
The following attestation bundles were made for access_mopper-2.3.0a24-py3-none-any.whl:
Publisher:
cd.yml on ACCESS-NRI/ACCESS-MOPPeR
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
access_mopper-2.3.0a24-py3-none-any.whl -
Subject digest:
7e5387dd0c906b3d7fe3786bc01a741bc3d5cd8c29a736c78e332e46cac8d55c - Sigstore transparency entry: 442791296
- Sigstore integration time:
-
Permalink:
ACCESS-NRI/ACCESS-MOPPeR@fc25b24db77b11986c1550ae0aa542583287455b -
Branch / Tag:
refs/tags/v2.3.0a24 - Owner: https://github.com/ACCESS-NRI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
cd.yml@fc25b24db77b11986c1550ae0aa542583287455b -
Trigger Event:
push
-
Statement type: