sparc package

Initialization of sparc-x-api

For submodules like download_data and api, ase / numpy may be ignored, and run using standard python libaries. This may be useful for cases like conda build and CI where not all dependencies are present

class sparc.SPARCMissingDeps(*args, **kwargs)

Bases: object

Subpackages

• sparc.sparc_parsers package
  • Submodules
    • sparc.sparc_parsers.aimd module
    • sparc.sparc_parsers.atoms module
      • atoms_bc_to_sparc()
      • atoms_to_dict()
      • constraints_from_relax()
      • count_symbols()
      • dict_to_atoms()
      • modify_atoms_bc()
      • relax_from_all_constraints()
      • relax_from_constraint()
    • sparc.sparc_parsers.geopt module
    • sparc.sparc_parsers.inpt module
    • sparc.sparc_parsers.ion module
      • InvalidSortingComment
    • sparc.sparc_parsers.out module
    • sparc.sparc_parsers.pseudopotential module
      • MultiplePseudoPotentialFiles
      • NoMatchingPseudopotential
      • NotPSP8Format
      • copy_psp_file()
      • find_pseudo_path()
      • infer_pseudo_path()
      • parse_psp8_header()
    • sparc.sparc_parsers.static module
    • sparc.sparc_parsers.utils module
      • bisect_and_strip()
      • get_label()
      • make_reverse_mapping()
      • read_block_input()
      • strip_comments()

Submodules

• sparc.api module
  • SparcAPI
    • SparcAPI.sparc_version
    • SparcAPI.categories
    • SparcAPI.parameters
    • SparcAPI.other_parameters
    • SparcAPI.data_types
    • SparcAPI.get_parameter_dict()
    • SparcAPI.help_info()
    • SparcAPI.validate_input()
    • SparcAPI.convert_string_to_value()
    • SparcAPI.convert_value_to_string()
    • SparcAPI.convert_string_to_value()
    • SparcAPI.convert_value_to_string()
    • SparcAPI.get_parameter_dict()
    • SparcAPI.help_info()
    • SparcAPI.validate_input()
• sparc.calculator module
  • SPARC
    • SPARC.ase_objtype
    • SPARC.atoms_dict()
    • SPARC.calculate()
    • SPARC.check_input_atoms()
    • SPARC.check_state()
    • SPARC.close()
    • SPARC.concatinate_output()
    • SPARC.default_params
    • SPARC.detect_socket_compatibility()
    • SPARC.detect_sparc_version()
    • SPARC.dict_atoms()
    • SPARC.directory
    • SPARC.ensure_socket()
    • SPARC.estimate_memory()
    • SPARC.execute()
    • SPARC.generate_command()
    • SPARC.get_fermi_level()
    • SPARC.get_geometric_steps()
    • SPARC.get_nstates()
    • SPARC.get_pseudopotential_directory()
    • SPARC.get_runtime()
    • SPARC.get_scf_steps()
    • SPARC.get_stress()
    • SPARC.implemented_properties
    • SPARC.in_socket_filename
    • SPARC.interpret_downsampling_input()
    • SPARC.interpret_grid_input()
    • SPARC.interpret_kpoint_input()
    • SPARC.interpret_kpoint_shift()
    • SPARC.label
    • SPARC.log
    • SPARC.name
    • SPARC.parse_MD()
    • SPARC.parse_input_args()
    • SPARC.parse_output()
    • SPARC.parse_relax()
    • SPARC.pid
    • SPARC.print_sysinfo()
    • SPARC.raw_results
    • SPARC.read_line()
    • SPARC.read_results()
    • SPARC.recover_index_order_from_ion_file()
    • SPARC.resort
    • SPARC.run_client()
    • SPARC.set()
    • SPARC.setup_parallel_env()
    • SPARC.socket_mode
    • SPARC.sort
    • SPARC.special_inputs
    • SPARC.use_socket
    • SPARC.write_input()
• sparc.cli module
  • main()
• sparc.client module
  • main()
  • split_socket_name()
• sparc.common module
• sparc.docparser module
  • SparcDocParser
    • SparcDocParser.version
    • SparcDocParser.parameter_categories
    • SparcDocParser.parameters
    • SparcDocParser.other_parameters
    • SparcDocParser.find_main_file()
    • SparcDocParser.get_include_files()
    • SparcDocParser.parse_version()
    • SparcDocParser.parse_parameters()
    • SparcDocParser.postprocess()
    • SparcDocParser.to_dict()
    • SparcDocParser.json_from_directory()
    • SparcDocParser.json_from_repo()
    • SparcDocParser.find_main_file()
    • SparcDocParser.get_include_files()
    • SparcDocParser.json_from_directory()
    • SparcDocParser.json_from_repo()
    • SparcDocParser.parse_parameters()
    • SparcDocParser.parse_version()
    • SparcDocParser.postprocess()
    • SparcDocParser.to_dict()
  • contain_only_bool()
  • convert_comment()
  • convert_tex_default()
  • convert_tex_example()
  • convert_tex_parameter()
  • is_array()
  • sanitize_default()
  • sanitize_description()
  • sanitize_type()
  • text2value()
• sparc.download_data module
  • checksum_all()
  • download_psp()
  • is_psp_download_complete()
• sparc.io module
  • SparcBundle
    • SparcBundle.directory
    • SparcBundle.mode
    • SparcBundle.label
    • SparcBundle.init_atoms
    • SparcBundle.init_inputs
    • SparcBundle.psp_data
    • SparcBundle.raw_results
    • SparcBundle.psp_dir
    • SparcBundle.sorting
    • SparcBundle.last_image
    • SparcBundle.validator
    • SparcBundle.__find_psp_dir()
    • SparcBundle._find_files()
    • SparcBundle._make_label()
    • SparcBundle._read_ion_and_inpt()
    • SparcBundle._write_ion_and_inpt()
    • SparcBundle._make_singlepoint()
    • SparcBundle.convert_to_ase()
    • SparcBundle.read_raw_results()
    • SparcBundle.read_psp_info()
    • SparcBundle.convert_to_ase()
    • SparcBundle.psp_env
    • SparcBundle.read_psp_info()
    • SparcBundle.read_raw_results()
    • SparcBundle.resort
    • SparcBundle.sort
  • read_sparc()
  • write_sparc()
• sparc.quicktest module
  • ApiTest
    • ApiTest.display_name
    • ApiTest.make_test()
  • BaseTest
    • BaseTest.dislay_name
    • BaseTest.display_docstring()
    • BaseTest.make_test()
    • BaseTest.run_test()
  • CommandTest
    • CommandTest.display_name
    • CommandTest.make_test()
  • FileIOCalcTest
    • FileIOCalcTest.display_name
    • FileIOCalcTest.make_test()
  • ImportTest
    • ImportTest.display_name
    • ImportTest.make_test()
  • PspTest
    • PspTest.display_name
    • PspTest.make_test()
  • SocketCalcTest
    • SocketCalcTest.display_name
    • SocketCalcTest.make_test()
  • main()
• sparc.socketio module
  • SPARCProtocol
    • SPARCProtocol.calculate_new_protocol()
    • SPARCProtocol.recv_object()
    • SPARCProtocol.recvinit()
    • SPARCProtocol.send_object()
    • SPARCProtocol.send_param()
    • SPARCProtocol.send_string()
    • SPARCProtocol.sendinit()
  • SPARCSocketClient
    • SPARCSocketClient.calculate()
    • SPARCSocketClient.irun()
    • SPARCSocketClient.run()
  • SPARCSocketServer
    • SPARCSocketServer.calculate_new_protocol()
    • SPARCSocketServer.calculate_origin_protocol()
    • SPARCSocketServer.proc
    • SPARCSocketServer.send_atoms_and_params()
    • SPARCSocketServer.socket_filename
  • generate_random_socket_name()
• sparc.utils module
  • ProcessReturned
  • TimeoutException
  • compare_dict()
  • cprint()
  • deprecated()
  • h2gpts()
  • locate_api()
  • monitor_process()
  • sanitize_path()
  • string2index()
  • time_limit()