Skip to content

MPoL-dev/examples

Repository files navigation

MPoL Examples

This repository hosts self-contained examples demonstrating MPoL functionality. More info on each example can be found in the README.md within each example folder. This repository is not continuously integrated with the rest of the codebase because the computational demands are too significant. If you do encounter an error, please log it as a GitHub issue.

Installing and running the examples

These examples strive to use real, or approximately real, data to demonstrate MPoL functionality. Unfortunately, using real ALMA data means that we must contend with the fact that the Python casatools package frequently lags supported SPEC 0 Python versions. This creates a situation where one needs both a deprecated Python version old enough to run casatools and a current Python version new enough to support modern development.

The initial 00 example

We've isolated the casatools dependency to the initial dataset download and extraction in the 00-download-and-extract-datasets example. In that folder, you will need to install casatools into an older Python version that still supports it (e.g., 3.10). (More Info)

All other examples

Once you have completed the 00 example and extracted the ALMA datasets to either .npz or .asdf formats, you can then copy these data products into the 01-... or 02-... example folders that require them. In those later example folders, it is assumed that you have activated a (virtual) python environment to which you've successfully installed the MPoL package, and that your version of python is at least the minimum current version supported by MPoL.

Each folder will have a requirements.txt file that lists the additional python packages necessary for the analysis specific to the example in that folder. You can install them with

pip install -r requirements.txt

Snakefile is a snakemake file setting up the workflow. Within each example directory, you can run

$ snakemake -c 1 all

and you should see all scripts execute in order.

List of Examples

About

Self-contained examples demonstrating MPoL

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors