Add Nexus license, readme, and copyright headers

git-svn-id: https://subversion.assembla.com/svn/qmcdev/trunk@6430 e5b18d87-469d-4833-9cc0-8cdfa06e9491
This commit is contained in:
Jaron Krogel 2015-02-09 20:43:50 +00:00
parent 72d4e7defb
commit 3b9ecbc2b2
71 changed files with 547 additions and 34 deletions

45
nexus/LICENSE Normal file
View File

@ -0,0 +1,45 @@
Notice:
Development work on Nexus was initiated by Jaron T. Krogel at UIUC in 2012.
This software is distributed under the UIUC/NCSA Open Source License (below).
-----------------------------------------------------------------------------
University of Illinois/NCSA Open Source License
Copyright (c) 2012, University of Illinois Board of Trustees.
All rights reserved.
Developed by:
Jaron T. Krogel
Department of Physics, University of Illinois at Urbana-Champaign
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
``Software''), to deal with the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimers.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimers in
the documentation and/or other materials provided with the
distribution.
* Neither the names of the NCSA, the University of Illinois,
nor the names of its contributors may be used to endorse or promote
products derived from this Software without specific prior written
permission.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS WITH THE SOFTWARE.

230
nexus/README Normal file
View File

@ -0,0 +1,230 @@
====================
== Nexus Readme ==
====================
Contents
1) About Nexus
2) Installation instructions
3) Summary of library files
1. About Nexus
======================================================================
Nexus was written by Jaron T. Krogel starting in 2012 at UIUC.
Most of the code was developed at ORNL after Dec. 2012.
2. Installation instructions (Linux only)
======================================================================
a. Ensure that Python and NumPy are available
-------------------------------------------------
The vast majority Linux distributions come with Python pre-installed.
To check for Python, type "python --version" at the command line.
You should see something like "Python 2.7.6". Nexus is only
compatible with Python 2.x (3.x is not yet supported). If Python
is not present on your system, you can install it by following the
instructions at:
http://docs.python-guide.org/en/latest/starting/install/linux/
With Python present, check for NumPy. Type "python" at the command
line. You will get an interactive prompt (">>>"). Now type
"import numpy" then "numpy.__version__". If the import is
successful and your version number is greater than 1.6.x, then
Nexus should work on your system. If you need to install numpy,
follow the instructions at:
http://docs.scipy.org/doc/numpy/user/install.html
Installation of NumPy on certain linux distributions is
straightforward (e.g. via apt-get or yum).
b. "Install" Nexus
-------------------------------------------------
All that should be needed to get Nexus working on your system
is to add the path to its library files to the PYTHONPATH
environment variable.
If the path to the directory this README file sits in is:
/your/path/to/nexus/
Then you can add one line to the .bashrc file in your
home directory:
export PYTHONPATH=/your/path/to/nexus/library/:$PYTHONPATH
After adding this line, type "source $HOME/.bashrc". Now check
that Nexus is available by typing "python" then "import nexus".
You should be able to use Nexus if the the import proceeds
without incident (i.e. no messages displayed).
3. Summary of important library files
======================================================================
a. Core facilities
-------------------------------------------------
abilities.py, generic.py, developer.py
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Abstract base classes for all Nexus classes. Defines abilities
such as querying, printing, etc. Also provides developer
interface functions such as error reporting and redirection for
unimplemented base class functions. Void class protects imports
and halts execution if items from unavailable modules are
encountered.
project_base.py
~~~~~~~~~~~~~~~
Base class for core Nexus classes. Communicates settings
information throughout the system.
project.py, nexus.py
~~~~~~~~~~~~~~~~~~~~
Central collection (imports) of all Nexus classes. Interface
to the "settings" function.
structure.py
~~~~~~~~~~~~
Contains the Structure class and structure generator functions.
physical_system.py
~~~~~~~~~~~~~~~~~~
Contains PhysicalSystem class and particle information.
simulation.py
~~~~~~~~~~~~~
Contains Simulation, SimulationInput, and SimulationAnalyzer
base classes. All core functionality of Simulation objects is
defined here. Also contains derived simulation classes (sim,
input, analyzer) for generic simulation codes. Enables driving
of virtually any single or multi- input file simulation code by
using input file templates.
machine.py
~~~~~~~~~~
Contains Job, Machine, Workstation, and Supercomputer classes.
Also contains all derived Supercomputer classes (Titan, Edison,
Mira, etc.)
project_manager.py
~~~~~~~~~~~~~~~~~~
Contains ProjectManager class. Code controlling workflow
management is generally shared between ProjectManager and
Simulation.
bundle.py
~~~~~~~~~
Contains a facility (the "bundle" function) for bundling
many simulation jobs into a single, larger batch job.
b. Derived classes for specific simulation codes
-------------------------------------------------
QMCPACK
~~~~~~~
Simulation: qmcpack.py
SimulationInput: qmcpack_input.py
SimulationAnalyzer: qmcpack_analyzer.py
Supporting analysis classes:
qaobject.py, qmcpack_analyzer_base.py,
qmcpack_method_analyzers.py, qmcpack_property_analyzers.py,
qmcpack_quantity_analyzers.py,qmcpack_result_analyzers.py,
spacegrid.py
Orbital conversion tools for QMCPACK:
convert4qmc.py, pw2qmcpack.py, wfconvert.py
PWSCF
~~~~~
Simulation: pwscf.py
SimulationInput: pwscf_input.py (read/write any input file)
SimulationAnalyzer: pwscf_analyzer.py (parse log output and data~file.xml)
VASP
~~~~~
Simulation: vasp.py
SimulationInput: vasp_input.py (read/write any input file)
SimulationAnalyzer: vasp_analyzer.py (parse OUTCAR and vasprun.xml)
GAMESS
~~~~~~
Simulation: gamess.py
SimulationInput: gamess_input.py (read/write any input file)
SimulationAnalyzer: gamess_analyzer.py (parse log output)
SQD
~~~
Simulation: sqd.py
SimulationInput: sqd_input.py
SimulationAnalyzer: sqd_analyzer.py
OPIUM
~~~~~
opium.py contains all three (sim, input, analyzer)
c. Miscellaneous facilities
-------------------------------------------------
debug.py
~~~~~~~~
Adds support for interactive code break points.
periodic_table.py
~~~~~~~~~~~~~~~~~
Access to periodic table data in a structured object format.
numerics.py, extended_numpy.py
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Statistics and curve fitting support.
unit_converter.py
~~~~~~~~~~~~~~~~~
Unit conversion of scalars and arrays.
xmlreader.py
~~~~~~~~~~~~
Class to convert XML file into structured object format.
hdfreader.py
~~~~~~~~~~~~
Class to convert HDF5 file into structured object containing
numpy arrays.
fileio.py
~~~~~~~~~
Interface to XSF files. Other will go here later.
plotting.py
~~~~~~~~~~~
Access to plotting functions via matplotlib.
pseudopotential.py
~~~~~~~~~~~~~~~~~~
Classes representing pseudopotentials. Functions supporting
pseudopotential conversion.
template_simulation.py
~~~~~~~~~~~~~~~~~~~~~~
Example and explanation for developers interested in
implementing new derived Simulation classes for codes
not yet supported by Nexus.

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
class genbase(object):

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from machines import Workstation,Job
from simulation import Simulation,NullSimulationInput,NullSimulationAnalyzer

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
import string

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from pw2qmcpack import Pw2qmcpack,Pw2qmcpackInput,Pw2qmcpackAnalyzer
from wfconvert import Wfconvert,WfconvertInput,WfconvertAnalyzer

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import code

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import array,zeros,ndarray,around,sqrt,arange

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import sys
import traceback

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from project_base import Pobj

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
#! /usr/bin/env python
import os

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from numpy import exp
from developer import unavailable

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from subprocess import Popen,PIPE

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import sys
from numpy import *

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import array,zeros,ndarray,around,arange,dot

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import array,ndarray,abs

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import array,ndarray,abs

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
#! /usr/bin/env python
from types import FunctionType,StringType,DictType

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import sys
import traceback

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from generic import obj
from developer import DevBase,unavailable

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from numpy import array,ndarray,minimum,abs,ix_,resize
import sys

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
import time

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
_proc_status = '/proc/%d/status' % os.getpid()

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from project import *

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import types as pytypes
from numpy import array,ndarray,zeros,linspace,pi,exp,sqrt,polyfit,polyval

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from generic import obj

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from generic import obj
from developer import DevBase
from unit_converter import UnitConverter

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from numpy import dot,array
from numpy.linalg import inv

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from abilities import AllAbilities

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from developer import unavailable
try:
from matplotlib.pyplot import figure,plot,xlabel,ylabel,title,show,ylim,legend,xlim,rcParams,savefig,bar,xticks,subplot,grid,setp,errorbar,loglog,semilogx,semilogy,text

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
@ -26,7 +30,6 @@ from qmcpack import generate_jastrows,generate_jastrow,generate_jastrow1,generat
from qmcpack import generate_cusp_correction
from auxiliary import *
from debug import *
from plotting import *
#set the machine if known, otherwise user will provide

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
import traceback

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
import time

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
#! /usr/bin/env python
import os

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from generic import obj

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from generic import obj

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import array
from generic import obj

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import array,fromstring,sqrt
from generic import obj

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import array

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
import types as pytypes
from copy import deepcopy

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from generic import obj
from developer import DevBase

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from project_base import Pobj
import qmcpack

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import array,dot,pi

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
#
# bugs

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from numpy import minimum,resize
from generic import obj

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import array,empty

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
import types as pytypes
import keyword

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
import re

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
#! /usr/bin/env python

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
import re

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from numpy import array,empty,zeros,sqrt
from generic import obj

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from datetime import datetime
# jtk library imports

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
import shutil
import string

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import re
import copy
from numpy import array,floor,sqrt,zeros,prod,dot,ones,empty,min,max

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from generic import obj

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import loadtxt,empty,array,abs

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
import types as pytypes

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
#! /usr/bin/env python
import os

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
'''
superstring

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from generic import obj

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from abilities import Callable

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from generic import obj

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import array,zeros

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os
from numpy import array,abs,empty,ndarray

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
import os

View File

@ -1,3 +1,7 @@
##################################################################
## (c) Copyright 2015- by Jaron T. Krogel ##
##################################################################
from xml.parsers import expat
from numpy import array

View File

@ -1,33 +0,0 @@
%%%%%%%%%%%%%%%%%
|| Nexus ||
%%%%%%%%%%%%%%%%%
Author: Jaron T. Krogel
1st Release: 24 May 2013
~~~~~~~~~~~~
| Contents |
~~~~~~~~~~~~
- License Agreement
- For Nexus Users
~~~~~~~~~~~~~~~~~~~~~
| License Agreement |
~~~~~~~~~~~~~~~~~~~~~
- since Nexus is currently distributed with QMCPACK it shares the same license
- see ../LICENSE
~~~~~~~~~~~~~~~~~~~
| For Nexus Users |
~~~~~~~~~~~~~~~~~~~
- For installation and use, see the Nexus User Guide
|
- ./documentation/nexus_user_guide.pdf