Welcome to xemc3’s documentation!

xemc3 provides an interface for collecting the output data from a EMC3 simulation into an xarray dataset, as well as accessor methods for common EMC3 analysis and plotting tasks.

Currently only in alpha (until 1.0 released) so please report any bugs, and feel free to raise issues asking questions or making suggestions.

Contents:

• Getting started
  • Installing
  • Basic tasks
  • Exercises
• Examples
  • Evaluate at
  • Heatflux post processing
  • Analysing traces
  • Introduction to xemc3
  • Loading the raw data is slow
  • Loading of data
• API reference
  • xemc3 Dataset
  • xemc3.load module
  • xemc3.write module
• Using xarray
  • Printing the dataset
  • Merging datasets
• Configure xemc3
  • Using the with context manager
  • Simply setting it in the code
  • Setting it in ~/.local/xemc3/config.yaml
• Custom filenames
  • Using a specific version
  • Ways to customise
  • Syntax
• CLI reference
  • xemc3-append-time - CLI interface
  • xemc3-to-netcdf - CLI interface
  • xemc3-divertor - CLI interface
  • xemc3-to-archive - CLI interface
• Citing xemc3

Installation

With pip:

pip install --user xemc3

You can run the tests by running pytest --pyargs xemc3.

xemc3 will install the required python packages when you run one of the above install commands if they are not already installed on your system.

Indices and tables

• Index

• Module Index

• Search Page