Skip to content

Commit a07e57b

Browse files
llnl-fespholm10
authored andcommitted
Update
1 parent b308664 commit a07e57b

File tree

1 file changed

+33
-27
lines changed

1 file changed

+33
-27
lines changed

INSTALL

+33-27
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,50 @@
11

2-
UEDGE is in a transitional phase from running in the BASIS environment,
3-
developed at LLNL, to Python. This version, tagged $Name: $, can
4-
run in both environments. If you have interest in the Basis version of
5-
UEDGE contact Bill Meyer ([email protected]). New installations of the
6-
Basis version are discouraged as there is no longer any official support
7-
for the Basis software. Unless you know otherwise, assume this checkout
8-
is intended for building the Python UEDGE module. The remainder of these
9-
installation instructions apply only to the Python version of UEDGE. The
10-
Python version of UEDGE has been build on several Linux distributions and
11-
on MacOSX High Sierra and Mojave.
2+
Uedge was originally developed to run in the Basis environment developed
3+
at LLNL. It has since been ported to run as a Python module. The Python
4+
module Uedge has been built on several Linux distributions and MacOSX versions.
125

6+
The Basis version of Uedge is deprecated. If you have interest in
7+
the Basis version of Uedge contact Bill Meyer ([email protected]). There
8+
is no longer any official support for the Basis software. The capability
9+
to build the Basis version is maintained for legacy installations and
10+
may be removed from the repository at any time.
1311

14-
Building Python UEDGE (pyUedge).
12+
13+
Building Python Uedge (pyUedge).
1514

1615
Prerequisites:
17-
- Python 2.7
18-
We recommend the Anaconda (2) Python data science distribution.
19-
This includes many useful packages. Besides the base Python
20-
packages pyUedge includes Python scripts that utilize the
21-
matplotlib and hdf5 packages. Numpy is a required package to
22-
build pyUedge.
16+
- Python 3.x
17+
Should work with all Python 3 versions.
18+
19+
Anaconda3 is a useful Python distribution but puts constraints
20+
on the compiler version that may be used to build pyUedge. The
21+
compiler must be compatible with the libraries that come included
22+
with Anaconda. Anaconda will report the gcc version that was used
23+
to build the included libraries. The compiler used must at least
24+
use the same C runtime library version.
2325

2426
- Fortran/C compilers
25-
Only gfortran and gcc have been tested.
27+
Only gfortran and gcc have been tested and supported.
2628

27-
Requisites:
2829
- Forthon
29-
Generates link between UEDGE Fortran and Python.
30-
pip install forthon
31-
- MPPL (More Productive Programming Language)
32-
MPPL is a Fortran preprocessor
33-
pip install mppl
30+
Generates link between Uedge Fortran and Python.
31+
"pip install forthon"
32+
33+
Requisites:
34+
- matplotlib
35+
pyUedge includes Python scripts that import maplotlib
36+
- h5py
37+
pyUedge includes Python scripts for saving/restoring results
38+
in hdf5 files.
3439

3540

3641
Install with pip:
3742
pip install uedge
3843

39-
****Note that there was a version numbering change. If a
40-
"pip show uedge" reports version 7.6 then a "pip uninstall uedge"
41-
and "pip install --no-cache-dir uedge" will be nesseccary.
44+
If pyUedge reports that an update is available then a
45+
"pip install uedge --upgrade" can be executed. If that results in
46+
multiple versions a "pip uninstall uedge" and
47+
"pip install --no-cache-dir uedge" will be nesseccary.
4248

4349
Install from git clone:
4450
python setup.py build

0 commit comments

Comments
 (0)