Skip to content
/ duat Public

A Python interface to the OSIRIS PIC code.

License

Notifications You must be signed in to change notification settings

Dih5/duat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Github release PyPI

license MIT

Documentation Status

duat

A Python interface to the OSIRIS PIC code.

Note this package is not supported by the OSIRIS developers, use at your own risk.

Features

The package provides an interface to the OSIRIS code, allowing:

  • Definition of input files in Python syntax, as well as loading data from an existing OSIRIS input.
  • Running OSIRIS from the Python interpreter, perhaps using a grid system and/or mpi.
  • Plotting results, reducing multidimensional data. Animations in time can also be created.

Installation

Assuming you have Python with pip:

  • To install the last release from pypi: pip install --upgrade duat.
  • To install the last development version: pip install --upgrade https://github.com/dih5/duat/archive/master.zip.

If you are a cool guy you'll prefer to use python3 and pip3 instead (unless you are a cool Arch Linux user).

Running

The suggested environment to run duat is Jupyter notebook, but you can also run it from a python script or from the python interpreter.

The updated documentation can be found here, check it for a starting guide.

Versioning

Beta releases will be tagged as v0.Y.Z where Y>1. For this beta releases, Y will increase if and only if backward-incompatible public API changes are introduced.