{"openapi":"3.1.0","info":{"title":"charabanc","description":"Character tables for physical chemistry.","version":"0.1.0"},"paths":{"/v1/point-groups":{"get":{"tags":["point groups"],"summary":"List the point groups","operationId":"list_groups_v1_point_groups_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupList"}}}}}}},"/v1/point-groups/{group_id}":{"get":{"tags":["point groups"],"summary":"A whole character table","operationId":"get_group_v1_point_groups__group_id__get","parameters":[{"name":"group_id","in":"path","required":true,"schema":{"type":"string","title":"Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/point-groups/{group_id}/irreps/{irrep_id}":{"get":{"tags":["point groups"],"summary":"One row","operationId":"get_irrep_v1_point_groups__group_id__irreps__irrep_id__get","parameters":[{"name":"group_id","in":"path","required":true,"schema":{"type":"string","title":"Group Id"}},{"name":"irrep_id","in":"path","required":true,"schema":{"type":"string","title":"Irrep Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IrrepResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/point-groups/{group_id}/classes/{class_id}":{"get":{"tags":["point groups"],"summary":"One column","operationId":"get_class_v1_point_groups__group_id__classes__class_id__get","parameters":[{"name":"group_id","in":"path","required":true,"schema":{"type":"string","title":"Group Id"}},{"name":"class_id","in":"path","required":true,"schema":{"type":"string","title":"Class Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/point-groups/{group_id}/irreps/{irrep_id}/classes/{class_id}":{"get":{"tags":["point groups"],"summary":"One character","operationId":"get_character_v1_point_groups__group_id__irreps__irrep_id__classes__class_id__get","parameters":[{"name":"group_id","in":"path","required":true,"schema":{"type":"string","title":"Group Id"}},{"name":"irrep_id","in":"path","required":true,"schema":{"type":"string","title":"Irrep Id"}},{"name":"class_id","in":"path","required":true,"schema":{"type":"string","title":"Class Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CharacterResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/point-groups/{group_id}/functions":{"get":{"tags":["point groups"],"summary":"The functions listed against each row","operationId":"get_functions_v1_point_groups__group_id__functions_get","parameters":[{"name":"group_id","in":"path","required":true,"schema":{"type":"string","title":"Group Id"}},{"name":"degree","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Degree"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"enum":["translation","rotation","quadratic","cubic"],"type":"string"},{"type":"null"}],"title":"Kind"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FunctionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CharacterResponse":{"properties":{"meta":{"$ref":"#/components/schemas/Meta","default":{"data_version":"0.1.0","licence":"CC-BY-4.0"}},"group":{"type":"string","title":"Group"},"entry":{"$ref":"#/components/schemas/Entry"}},"type":"object","required":["group","entry"],"title":"CharacterResponse"},"ClassResponse":{"properties":{"meta":{"$ref":"#/components/schemas/Meta","default":{"data_version":"0.1.0","licence":"CC-BY-4.0"}},"group":{"type":"string","title":"Group"},"conjugacy_class":{"$ref":"#/components/schemas/ConjugacyClass"},"characters":{"items":{"$ref":"#/components/schemas/Entry"},"type":"array","title":"Characters"}},"type":"object","required":["group","conjugacy_class","characters"],"title":"ClassResponse"},"Component":{"properties":{"characters":{"items":{"anyOf":[{"$ref":"#/components/schemas/NumberCell"},{"$ref":"#/components/schemas/FunctionCell"}]},"type":"array","title":"Characters"}},"additionalProperties":false,"type":"object","required":["characters"],"title":"Component","description":"One line of a separably degenerate pair."},"ConjugacyClass":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"},"latex":{"type":"string","title":"Latex"},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Size","description":"Members; null if infinitely many"},"parameter":{"anyOf":[{"type":"string","const":"phi"},{"type":"null"}],"title":"Parameter"},"representative":{"$ref":"#/components/schemas/Operation"}},"additionalProperties":false,"type":"object","required":["id","text","latex","size","representative"],"title":"ConjugacyClass"},"Definition":{"properties":{"text":{"type":"string","title":"Text"},"latex":{"type":"string","title":"Latex"}},"additionalProperties":false,"type":"object","required":["text","latex"],"title":"Definition"},"Entry":{"properties":{"irrep":{"type":"string","title":"Irrep"},"class":{"type":"string","title":"Class"},"character":{"anyOf":[{"$ref":"#/components/schemas/NumberCell"},{"$ref":"#/components/schemas/FunctionCell"}],"title":"Character"},"components":{"items":{"anyOf":[{"$ref":"#/components/schemas/NumberCell"},{"$ref":"#/components/schemas/FunctionCell"}]},"type":"array","title":"Components","default":[]}},"type":"object","required":["irrep","class","character"],"title":"Entry","description":"One character: a pair has its two lines in `components`."},"Exact":{"properties":{"n":{"type":"integer","minimum":1.0,"title":"N"},"terms":{"items":{"prefixItems":[{"type":"integer"},{"type":"integer"}],"type":"array","maxItems":2,"minItems":2},"type":"array","title":"Terms"}},"additionalProperties":false,"type":"object","required":["n","terms"],"title":"Exact","description":"A sum of roots of unity: c * exp(2 pi i p / n) for each [c, p] in terms."},"Function":{"properties":{"text":{"type":"string","title":"Text"},"latex":{"type":"string","title":"Latex"},"terms":{"anyOf":[{"items":{"$ref":"#/components/schemas/Term"},"type":"array"},{"type":"null"}],"title":"Terms"},"axis":{"anyOf":[{"type":"string","enum":["x","y","z"]},{"type":"null"}],"title":"Axis"}},"additionalProperties":false,"type":"object","required":["text","latex"],"title":"Function","description":"One function: a polynomial (`terms`) or a rotation about an `axis`."},"FunctionCell":{"properties":{"kind":{"type":"string","const":"function","title":"Kind","default":"function"},"amplitude":{"type":"integer","title":"Amplitude"},"multiple":{"type":"integer","minimum":1.0,"title":"Multiple"},"parameter":{"type":"string","const":"phi","title":"Parameter","default":"phi"},"latex":{"type":"string","title":"Latex"}},"additionalProperties":false,"type":"object","required":["amplitude","multiple","latex"],"title":"FunctionCell","description":"amplitude * cos(multiple * phi), for a column of an infinite group."},"FunctionEntry":{"properties":{"irrep":{"type":"string","title":"Irrep"},"function_set":{"$ref":"#/components/schemas/FunctionSet"}},"type":"object","required":["irrep","function_set"],"title":"FunctionEntry"},"FunctionSet":{"properties":{"kind":{"type":"string","enum":["translation","rotation","quadratic","cubic"],"title":"Kind"},"degree":{"type":"integer","title":"Degree"},"text":{"type":"string","title":"Text"},"latex":{"type":"string","title":"Latex"},"basis":{"items":{"$ref":"#/components/schemas/Function"},"type":"array","title":"Basis"}},"additionalProperties":false,"type":"object","required":["kind","degree","text","latex","basis"],"title":"FunctionSet","description":"Functions that transform together as one row of the table."},"FunctionsResponse":{"properties":{"meta":{"$ref":"#/components/schemas/Meta","default":{"data_version":"0.1.0","licence":"CC-BY-4.0"}},"group":{"type":"string","title":"Group"},"functions":{"items":{"$ref":"#/components/schemas/FunctionEntry"},"type":"array","title":"Functions"}},"type":"object","required":["group","functions"],"title":"FunctionsResponse"},"Group":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"},"latex":{"type":"string","title":"Latex"},"hermann_mauguin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hermann Mauguin"},"hermann_mauguin_latex":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hermann Mauguin Latex"},"order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order","description":"Number of elements; null if infinite"},"truncated":{"type":"boolean","title":"Truncated","description":"True if more irreps exist than are listed","default":false},"definitions":{"items":{"$ref":"#/components/schemas/Definition"},"type":"array","title":"Definitions","default":[]},"notes":{"items":{"type":"string"},"type":"array","title":"Notes","description":"Footnotes on the conventions, with inline maths in \\( \\)","default":[]},"generators":{"items":{"$ref":"#/components/schemas/Operation"},"type":"array","title":"Generators","default":[]},"classes":{"items":{"$ref":"#/components/schemas/ConjugacyClass"},"type":"array","title":"Classes"},"irreps":{"items":{"$ref":"#/components/schemas/Irrep"},"type":"array","title":"Irreps"}},"additionalProperties":false,"type":"object","required":["id","text","latex","order","classes","irreps"],"title":"Group"},"GroupList":{"properties":{"meta":{"$ref":"#/components/schemas/Meta","default":{"data_version":"0.1.0","licence":"CC-BY-4.0"}},"groups":{"items":{"$ref":"#/components/schemas/GroupSummary"},"type":"array","title":"Groups"}},"type":"object","required":["groups"],"title":"GroupList"},"GroupResponse":{"properties":{"meta":{"$ref":"#/components/schemas/Meta","default":{"data_version":"0.1.0","licence":"CC-BY-4.0"}},"group":{"$ref":"#/components/schemas/Group"}},"type":"object","required":["group"],"title":"GroupResponse"},"GroupSummary":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"},"latex":{"type":"string","title":"Latex"},"hermann_mauguin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hermann Mauguin"},"hermann_mauguin_latex":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hermann Mauguin Latex"},"order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order","description":"Number of elements; null if infinite"}},"additionalProperties":false,"type":"object","required":["id","text","latex","order"],"title":"GroupSummary"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Irrep":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"},"latex":{"type":"string","title":"Latex"},"dimension":{"type":"integer","title":"Dimension"},"characters":{"items":{"anyOf":[{"$ref":"#/components/schemas/NumberCell"},{"$ref":"#/components/schemas/FunctionCell"}]},"type":"array","title":"Characters"},"components":{"items":{"$ref":"#/components/schemas/Component"},"type":"array","title":"Components","description":"The two lines of a separably degenerate pair","default":[]},"functions":{"items":{"$ref":"#/components/schemas/FunctionSet"},"type":"array","title":"Functions","default":[]}},"additionalProperties":false,"type":"object","required":["id","text","latex","dimension","characters"],"title":"Irrep"},"IrrepResponse":{"properties":{"meta":{"$ref":"#/components/schemas/Meta","default":{"data_version":"0.1.0","licence":"CC-BY-4.0"}},"group":{"type":"string","title":"Group"},"classes":{"items":{"type":"string"},"type":"array","title":"Classes"},"irrep":{"$ref":"#/components/schemas/Irrep"}},"type":"object","required":["group","classes","irrep"],"title":"IrrepResponse"},"Meta":{"properties":{"data_version":{"type":"string","title":"Data Version","default":"0.1.0"},"licence":{"type":"string","title":"Licence","default":"CC-BY-4.0"}},"type":"object","title":"Meta"},"NumberCell":{"properties":{"kind":{"type":"string","const":"number","title":"Kind","default":"number"},"re":{"type":"number","title":"Re"},"im":{"type":"number","title":"Im"},"exact":{"$ref":"#/components/schemas/Exact"},"latex":{"type":"string","title":"Latex"}},"additionalProperties":false,"type":"object","required":["re","im","exact","latex"],"title":"NumberCell"},"Operation":{"properties":{"type":{"type":"string","enum":["identity","rotation","reflection","inversion","improper"],"title":"Type"},"axis":{"anyOf":[{"prefixItems":[{"anyOf":[{"type":"integer"},{"type":"number"}]},{"anyOf":[{"type":"integer"},{"type":"number"}]},{"anyOf":[{"type":"integer"},{"type":"number"}]}],"type":"array","maxItems":3,"minItems":3},{"type":"null"}],"title":"Axis"},"turns":{"anyOf":[{"prefixItems":[{"type":"integer"},{"type":"integer"}],"type":"array","maxItems":2,"minItems":2},{"type":"null"}],"title":"Turns"},"parameter":{"anyOf":[{"type":"string","const":"phi"},{"type":"null"}],"title":"Parameter"},"normal":{"anyOf":[{"prefixItems":[{"anyOf":[{"type":"integer"},{"type":"number"}]},{"anyOf":[{"type":"integer"},{"type":"number"}]},{"anyOf":[{"type":"integer"},{"type":"number"}]}],"type":"array","maxItems":3,"minItems":3},{"type":"null"}],"title":"Normal"}},"additionalProperties":false,"type":"object","required":["type"],"title":"Operation","description":"A symmetry operation, stated exactly.\n\nA rotation is about `axis`, through `turns[0] / turns[1]` of a full turn or, if\n`parameter` is set, through phi. An improper rotation is that rotation followed by\nreflection in the plane perpendicular to the axis."},"Term":{"prefixItems":[{"type":"integer","title":"Coefficient"},{"prefixItems":[{"type":"integer"},{"type":"integer"},{"type":"integer"}],"type":"array","maxItems":3,"minItems":3,"title":"Powers"}],"type":"array","maxItems":2,"minItems":2},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}