SPARC-X-API
Contents
Installation
Configurations for SPARC-X-API
Basic Usage
Advanced Usage: SPARC-X-API as a Socket Interface
Examples
SPARC-X-API Package Components
Advanced Topics
Changes in API
Troubleshooting
How to Contribute
Documentation for Maintainers
SPARC-X-API
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__find_psp_dir() (sparc.io.SparcBundle method)
_find_files() (sparc.io.SparcBundle method)
_make_label() (sparc.io.SparcBundle method)
_make_singlepoint() (sparc.io.SparcBundle method)
_read_ion_and_inpt() (sparc.io.SparcBundle method)
_write_ion_and_inpt() (sparc.io.SparcBundle method)
A
ApiTest (class in sparc.quicktest)
ase_objtype (sparc.calculator.SPARC attribute)
atoms_bc_to_sparc() (in module sparc.sparc_parsers.atoms)
atoms_dict() (sparc.calculator.SPARC method)
atoms_to_dict() (in module sparc.sparc_parsers.atoms)
B
BaseTest (class in sparc.quicktest)
bisect_and_strip() (in module sparc.sparc_parsers.utils)
C
calculate() (sparc.calculator.SPARC method)
(sparc.socketio.SPARCSocketClient method)
calculate_new_protocol() (sparc.socketio.SPARCProtocol method)
(sparc.socketio.SPARCSocketServer method)
calculate_origin_protocol() (sparc.socketio.SPARCSocketServer method)
categories (sparc.api.SparcAPI attribute)
check_input_atoms() (sparc.calculator.SPARC method)
check_state() (sparc.calculator.SPARC method)
checksum_all() (in module sparc.download_data)
close() (sparc.calculator.SPARC method)
CommandTest (class in sparc.quicktest)
compare_dict() (in module sparc.utils)
concatinate_output() (sparc.calculator.SPARC method)
constraints_from_relax() (in module sparc.sparc_parsers.atoms)
contain_only_bool() (in module sparc.docparser)
convert_comment() (in module sparc.docparser)
convert_string_to_value() (sparc.api.SparcAPI method)
,
[1]
convert_tex_default() (in module sparc.docparser)
convert_tex_example() (in module sparc.docparser)
convert_tex_parameter() (in module sparc.docparser)
convert_to_ase() (sparc.io.SparcBundle method)
,
[1]
convert_value_to_string() (sparc.api.SparcAPI method)
,
[1]
copy_psp_file() (in module sparc.sparc_parsers.pseudopotential)
count_symbols() (in module sparc.sparc_parsers.atoms)
cprint() (in module sparc.utils)
D
data_types (sparc.api.SparcAPI attribute)
default_params (sparc.calculator.SPARC attribute)
deprecated() (in module sparc.utils)
detect_socket_compatibility() (sparc.calculator.SPARC method)
detect_sparc_version() (sparc.calculator.SPARC method)
dict_atoms() (sparc.calculator.SPARC method)
dict_to_atoms() (in module sparc.sparc_parsers.atoms)
directory (sparc.calculator.SPARC property)
(sparc.io.SparcBundle attribute)
dislay_name (sparc.quicktest.BaseTest property)
display_docstring() (sparc.quicktest.BaseTest method)
display_name (sparc.quicktest.ApiTest attribute)
(sparc.quicktest.CommandTest attribute)
(sparc.quicktest.FileIOCalcTest attribute)
(sparc.quicktest.ImportTest attribute)
(sparc.quicktest.PspTest attribute)
(sparc.quicktest.SocketCalcTest attribute)
download_psp() (in module sparc.download_data)
E
ensure_socket() (sparc.calculator.SPARC method)
estimate_memory() (sparc.calculator.SPARC method)
execute() (sparc.calculator.SPARC method)
F
FileIOCalcTest (class in sparc.quicktest)
find_main_file() (sparc.docparser.SparcDocParser method)
,
[1]
find_pseudo_path() (in module sparc.sparc_parsers.pseudopotential)
G
generate_command() (sparc.calculator.SPARC method)
generate_random_socket_name() (in module sparc.socketio)
get_fermi_level() (sparc.calculator.SPARC method)
get_geometric_steps() (sparc.calculator.SPARC method)
get_include_files() (sparc.docparser.SparcDocParser method)
,
[1]
get_label() (in module sparc.sparc_parsers.utils)
get_nstates() (sparc.calculator.SPARC method)
get_parameter_dict() (sparc.api.SparcAPI method)
,
[1]
get_pseudopotential_directory() (sparc.calculator.SPARC method)
get_runtime() (sparc.calculator.SPARC method)
get_scf_steps() (sparc.calculator.SPARC method)
get_stress() (sparc.calculator.SPARC method)
H
h2gpts() (in module sparc.utils)
help_info() (sparc.api.SparcAPI method)
,
[1]
I
implemented_properties (sparc.calculator.SPARC attribute)
ImportTest (class in sparc.quicktest)
in_socket_filename (sparc.calculator.SPARC property)
infer_pseudo_path() (in module sparc.sparc_parsers.pseudopotential)
init_atoms (sparc.io.SparcBundle attribute)
init_inputs (sparc.io.SparcBundle attribute)
interpret_downsampling_input() (sparc.calculator.SPARC method)
interpret_grid_input() (sparc.calculator.SPARC method)
interpret_kpoint_input() (sparc.calculator.SPARC method)
interpret_kpoint_shift() (sparc.calculator.SPARC method)
InvalidSortingComment
irun() (sparc.socketio.SPARCSocketClient method)
is_array() (in module sparc.docparser)
is_psp_download_complete() (in module sparc.download_data)
J
json_from_directory() (sparc.docparser.SparcDocParser class method)
(sparc.docparser.SparcDocParser method)
json_from_repo() (sparc.docparser.SparcDocParser class method)
(sparc.docparser.SparcDocParser method)
L
label (sparc.calculator.SPARC property)
(sparc.io.SparcBundle attribute)
last_image (sparc.io.SparcBundle attribute)
locate_api() (in module sparc.utils)
log (sparc.calculator.SPARC property)
M
main() (in module sparc.cli)
(in module sparc.client)
(in module sparc.quicktest)
make_reverse_mapping() (in module sparc.sparc_parsers.utils)
make_test() (sparc.quicktest.ApiTest method)
(sparc.quicktest.BaseTest method)
(sparc.quicktest.CommandTest method)
(sparc.quicktest.FileIOCalcTest method)
(sparc.quicktest.ImportTest method)
(sparc.quicktest.PspTest method)
(sparc.quicktest.SocketCalcTest method)
mode (sparc.io.SparcBundle attribute)
modify_atoms_bc() (in module sparc.sparc_parsers.atoms)
module
sparc
sparc.api
sparc.calculator
sparc.cli
sparc.client
sparc.common
sparc.docparser
sparc.download_data
sparc.io
sparc.quicktest
sparc.socketio
sparc.sparc_parsers
sparc.sparc_parsers.aimd
sparc.sparc_parsers.atoms
sparc.sparc_parsers.geopt
sparc.sparc_parsers.inpt
sparc.sparc_parsers.ion
sparc.sparc_parsers.out
sparc.sparc_parsers.pseudopotential
sparc.sparc_parsers.static
sparc.sparc_parsers.utils
sparc.utils
monitor_process() (in module sparc.utils)
MultiplePseudoPotentialFiles
N
name (sparc.calculator.SPARC attribute)
NoMatchingPseudopotential
NotPSP8Format
O
other_parameters (sparc.api.SparcAPI attribute)
(sparc.docparser.SparcDocParser attribute)
P
parameter_categories (sparc.docparser.SparcDocParser attribute)
parameters (sparc.api.SparcAPI attribute)
(sparc.docparser.SparcDocParser attribute)
parse_input_args() (sparc.calculator.SPARC method)
parse_MD() (sparc.calculator.SPARC method)
parse_output() (sparc.calculator.SPARC method)
parse_parameters() (sparc.docparser.SparcDocParser method)
,
[1]
parse_psp8_header() (in module sparc.sparc_parsers.pseudopotential)
parse_relax() (sparc.calculator.SPARC method)
parse_version() (sparc.docparser.SparcDocParser method)
,
[1]
pid (sparc.calculator.SPARC property)
postprocess() (sparc.docparser.SparcDocParser method)
,
[1]
print_sysinfo() (sparc.calculator.SPARC method)
proc (sparc.socketio.SPARCSocketServer property)
ProcessReturned
psp_data (sparc.io.SparcBundle attribute)
psp_dir (sparc.io.SparcBundle attribute)
psp_env (sparc.io.SparcBundle attribute)
PspTest (class in sparc.quicktest)
R
raw_results (sparc.calculator.SPARC property)
(sparc.io.SparcBundle attribute)
read_block_input() (in module sparc.sparc_parsers.utils)
read_line() (sparc.calculator.SPARC method)
read_psp_info() (sparc.io.SparcBundle method)
,
[1]
read_raw_results() (sparc.io.SparcBundle method)
,
[1]
read_results() (sparc.calculator.SPARC method)
read_sparc() (in module sparc.io)
recover_index_order_from_ion_file() (sparc.calculator.SPARC method)
recv_object() (sparc.socketio.SPARCProtocol method)
recvinit() (sparc.socketio.SPARCProtocol method)
relax_from_all_constraints() (in module sparc.sparc_parsers.atoms)
relax_from_constraint() (in module sparc.sparc_parsers.atoms)
resort (sparc.calculator.SPARC property)
(sparc.io.SparcBundle property)
run() (sparc.socketio.SPARCSocketClient method)
run_client() (sparc.calculator.SPARC method)
run_test() (sparc.quicktest.BaseTest method)
S
sanitize_default() (in module sparc.docparser)
sanitize_description() (in module sparc.docparser)
sanitize_path() (in module sparc.utils)
sanitize_type() (in module sparc.docparser)
send_atoms_and_params() (sparc.socketio.SPARCSocketServer method)
send_object() (sparc.socketio.SPARCProtocol method)
send_param() (sparc.socketio.SPARCProtocol method)
send_string() (sparc.socketio.SPARCProtocol method)
sendinit() (sparc.socketio.SPARCProtocol method)
set() (sparc.calculator.SPARC method)
setup_parallel_env() (sparc.calculator.SPARC method)
socket_filename (sparc.socketio.SPARCSocketServer property)
socket_mode (sparc.calculator.SPARC property)
SocketCalcTest (class in sparc.quicktest)
sort (sparc.calculator.SPARC property)
(sparc.io.SparcBundle property)
sorting (sparc.io.SparcBundle attribute)
sparc
module
SPARC (class in sparc.calculator)
sparc.api
module
sparc.calculator
module
sparc.cli
module
sparc.client
module
sparc.common
module
sparc.docparser
module
sparc.download_data
module
sparc.io
module
sparc.quicktest
module
sparc.socketio
module
sparc.sparc_parsers
module
sparc.sparc_parsers.aimd
module
sparc.sparc_parsers.atoms
module
sparc.sparc_parsers.geopt
module
sparc.sparc_parsers.inpt
module
sparc.sparc_parsers.ion
module
sparc.sparc_parsers.out
module
sparc.sparc_parsers.pseudopotential
module
sparc.sparc_parsers.static
module
sparc.sparc_parsers.utils
module
sparc.utils
module
sparc_version (sparc.api.SparcAPI attribute)
SparcAPI (class in sparc.api)
SparcBundle (class in sparc.io)
SparcDocParser (class in sparc.docparser)
SPARCMissingDeps (class in sparc)
SPARCProtocol (class in sparc.socketio)
SPARCSocketClient (class in sparc.socketio)
SPARCSocketServer (class in sparc.socketio)
special_inputs (sparc.calculator.SPARC attribute)
split_socket_name() (in module sparc.client)
string2index() (in module sparc.utils)
strip_comments() (in module sparc.sparc_parsers.utils)
T
text2value() (in module sparc.docparser)
time_limit() (in module sparc.utils)
TimeoutException
to_dict() (sparc.docparser.SparcDocParser method)
,
[1]
U
use_socket (sparc.calculator.SPARC property)
V
validate_input() (sparc.api.SparcAPI method)
,
[1]
validator (sparc.io.SparcBundle attribute)
version (sparc.docparser.SparcDocParser attribute)
W
write_input() (sparc.calculator.SPARC method)
write_sparc() (in module sparc.io)