A scripting system for the Last Millennium Reanalysis (LMR) project
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
slmr
.gitignore
Makefile
README.md
setup.py

README.md

PyPI

sLMR

This is a scripting system for the Last Millennium Reanalysis project, or LMR.

Requirement

Python 3

Features

  • [v0.1] Running LMR with Slurm on a cluster with just one command line
  • [v0.2] Post-processing: pick files with the same filename from different directories

How to install

Simply

pip install slmr

and there will be an executable command slmr in your PATH.

Usage examples

Below are some usage examples of slmr. For more details, please check

slmr -h

Running LMR with Slurm

We need to prepare all the data and configurations required for LMR first, then we are able to run LMR with Slurm on a cluster with just one command line:

slmr job -c config.yml -n 4 -nn hungus -rp 0 2000 -em slmr@gmail.com -x test_ccsm4

# slmr job: use the mode of submitting a slurm job
# -c config.yml: use "config.yml" as a configuration template
# -n 4 -nn hungus: run LRM with 4 threads on the node "hungus"
# -rp 0 2000: reconstruction period to be from 0 to 2000 C.E.
# -em slmr@gmail.com: notification will be sent to "slmr@gmail.com"
# -x test_ccsm4: the experiment is named as "test_ccsm4"

Post-processing: pick files

slmr pp pick_files -f gmt.npz -d dir1 dir2 -s ./gmt_files

# slmr pp: use the mode of post-processing
# pick_files: the post-processing task to be pick_files
# -f gmt.npz: pick files named as "gmt.npz"
# -d dir1 dir2: pick files from the specified directories dir1 and dir2; more dirs can be followed
# -s ./gmt_files: save the found files to the directory "./gmt_files"

License

MIT License

Copyright (c) 2018 Feng Zhu