Skip to content

Commit

Permalink
Defined basic imports in __init__.py
Browse files Browse the repository at this point in the history
  • Loading branch information
RealPolitiX committed Jul 27, 2020
1 parent d542d37 commit 6e222ac
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ import mpes.fprocessing as fp
import mpes.analysis as aly
import mpes.visualization as vis
```
which can also be done without using the aliases simply as (not recommended)
```
from mpes import *
```

### Using mayavi in Jupyter notebook
For 3D rendering of multidimensional dataset, the mpes package takes advantage of the recent version of mayavi (4.5.0 and above) with jupyter notebook support through [x3dom](https://www.x3dom.org/). Follow the steps below on the command line to allow mayavi output to be displayed on jupyter/ipython notebook
Expand Down
2 changes: 1 addition & 1 deletion mpes/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
__version_info__ = ('0', '9', '8')
__version__ = '.'.join(__version_info__)
__author__ = 'R. Patrick Xian, Laurenz Rettig'
__all__ = []
__all__ = ['fprocessing', 'analysis', 'visualization', 'utils']

0 comments on commit 6e222ac

Please sign in to comment.