.. reference/index.rst

Reference
=========

casm.api
--------

.. autosummary::
    :toctree:

    casm.api.API
    casm.api.command_list
    casm.api.casm_command
    casm.api.casm_capture

casm.learn
----------

.. autosummary::
    :toctree:

    casm.learn.create_halloffame
    casm.learn.EqualIndividual
    casm.learn.empty_individual
    casm.learn.example_input_Lasso
    casm.learn.example_input_LassoCV
    casm.learn.example_input_RFE
    casm.learn.example_input_GeneticAlgorithm
    casm.learn.example_input_IndividualBestFirst
    casm.learn.example_input_PopulationBestFirst
    casm.learn.example_input_DirectSelection
    casm.learn.open_input
    casm.learn.set_input_defaults
    casm.learn.FittingData
    casm.learn.TrainingData
    casm.learn.print_input_help
    casm.learn.print_individual
    casm.learn.print_population
    casm.learn.print_halloffame
    casm.learn.print_eci
    casm.learn.to_json
    casm.learn.open_halloffame
    casm.learn.save_halloffame
    casm.learn.checkspecs
    casm.learn.checkhull
    casm.learn.fit_and_select
    casm.learn.direct_fit

casm.project
------------

.. autosummary::
    :toctree:

    casm.project.project_path
    casm.project.ClexDescription
    casm.project.ProjectSettings
    casm.project.DirectoryStructure
    casm.project.Project
    casm.project.Prim
    casm.project.Selection
    casm.project.query
    casm.project.write_eci
    casm.project.AttributeInfo

casm.vasp
---------

.. autosummary::
    :toctree:

    casm.vasp.io
    casm.vasp.VaspError
    casm.vasp.VaspWarning
    casm.vasp.continue_job
    casm.vasp.IbzkptError
    casm.vasp.FEXCFError
    casm.vasp.SubSpaceMatrixError
    casm.vasp.InisymError
    casm.vasp.SgrconError
    casm.vasp.WavecarError
    casm.vasp.NbandsError
    casm.vasp.NoConvergeError
    casm.vasp.FreezeError
    casm.vasp.error_check
    casm.vasp.crash_check
    casm.vasp.complete_job
    casm.vasp.run
    casm.vasp.Relax
    casm.vasp.Converge

casm.vasp.io
------------

.. autosummary::
    :toctree:

    casm.vasp.io.VASP_INPUT_FILE_LIST
    casm.vasp.io.DEFAULT_VASP_MOVE_LIST
    casm.vasp.io.DEFAULT_VASP_COPY_LIST
    casm.vasp.io.DEFAULT_VASP_REMOVE_LIST
    casm.vasp.io.VaspIOError
    casm.vasp.io.job_complete
    casm.vasp.io.get_incar_tag
    casm.vasp.io.set_incar_tag
    casm.vasp.io.ionic_steps
    casm.vasp.io.write_potcar
    casm.vasp.io.write_stopcar
    casm.vasp.io.write_vasp_input
    casm.vasp.io.VASP_TAG_INT_LIST
    casm.vasp.io.VASP_TAG_FLOAT_LIST
    casm.vasp.io.VASP_TAG_BOOL_LIST
    casm.vasp.io.VASP_TAG_SITEF_LIST
    casm.vasp.io.VASP_TAG_SPECF_LIST
    casm.vasp.io.VASP_TAG_SPECI_LIST
    casm.vasp.io.VASP_TAG_STRING_LIST
    casm.vasp.io.VASP_TAG_LIST
    casm.vasp.io.IncarError
    casm.vasp.io.Incar
    casm.vasp.io.KpointsError
    casm.vasp.io.Kpoints
    casm.vasp.io.OutcarError
    casm.vasp.io.Outcar
    casm.vasp.io.OszicarError
    casm.vasp.io.Oszicar
    casm.vasp.io.Site
    casm.vasp.io.PoscarError
    casm.vasp.io.Poscar
    casm.vasp.io.SpeciesError
    casm.vasp.io.SpeciesDict
    casm.vasp.io.IndividualSpecies
    casm.vasp.io.species_settings
    casm.vasp.io.write_species_settings
    casm.vasp.io.VaspIO
    casm.vasp.io.VasprunError
    casm.vasp.io.Vasprun
    casm.vasp.io.OrbitalOccupationError
    casm.vasp.io.OrbitalOccupation
    casm.vasp.io.write_occupations
    casm.vasp.io.CmagspinAttr

casm.vaspwrapper
----------------

.. autosummary::
    :toctree:

    casm.vaspwrapper.Converge
    casm.vaspwrapper.Relax
    casm.vaspwrapper.VaspCalculatorBase
    casm.vaspwrapper.VaspWrapperError
    casm.vaspwrapper.read_settings
    casm.vaspwrapper.write_settings
    casm.vaspwrapper.vasp_input_file_names

casm.wrapper
------------

.. autosummary::
    :toctree:

    casm.wrapper.jobname