Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature] improve documentation #3

Open
4 tasks
ezpzbz opened this issue Sep 2, 2021 · 1 comment
Open
4 tasks

[feature] improve documentation #3

ezpzbz opened this issue Sep 2, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@ezpzbz
Copy link
Owner

ezpzbz commented Sep 2, 2021

I will add few more sections to the documentation:

  • Full example of running calculation using SinglefileData
  • Full example of running calculation using StructureData and proving charges as input parameter
  • A complete script and example on how to use resulting structures for further calculations with other plugins
  • Full example of a case with magnetic enumeration
@ezpzbz ezpzbz self-assigned this Sep 2, 2021
@ezpzbz ezpzbz added the documentation Improvements or additions to documentation label Sep 2, 2021
@ezpzbz ezpzbz added this to the v1.0.0 milestone Sep 2, 2021
@ezpzbz
Copy link
Owner Author

ezpzbz commented Sep 12, 2021

Sample output dict for documentation:

Groups

"Chemical_formula": {
        "Initial": "Al4Ca4O14Si2",
        "Supercell": "Al8Ca8O28Si4"
    },
    "Crystallographic_groups": {
        "Group1": {
            "Site1": {
                "Actual_occupancy": 0.5,
                "Initial_occupancy": 0.5,
                "Symbol": "Al10",
                "Type": {
                    "distributed": {
                        "considered_sites": "1",
                        "total_sites": "2"
                    }
                }
            },
            "Site2": {
                "Actual_occupancy": 0.5,
                "Initial_occupancy": 0.5,
                "Symbol": "Si11",
                "Type": {
                    "distributed": {
                        "considered_sites": "1",
                        "total_sites": "2"
                    }
                }
            }
        },
        "Group10": {
            "Site1": {
                "Actual_occupancy": 1.0,
                "Initial_occupancy": 1.0,
                "Symbol": "Ca3",
                "Type": "FIXED"
            }
        },

Symmetry and structures

"Number_of_structures": {
        "symmetrically_distinct": 8,
        "total_combinations": 16
    },
    "Number_of_symmetry_operations": 2,
    "Random_seed": 2225839783,
    "Structures_info": {
        "ia07": {
            "coulombic_energy": -1693.13,
            "crystal_system": "monoclinic",
            "degeneracy": 2,
            "lattice_type": "monoclinic",
            "space_group_symbol": "Cm"
        },
        "if00": {
            "coulombic_energy": -1694.042,
            "crystal_system": "tetragonal",
            "degeneracy": 2,
            "lattice_type": "tetragonal",
            "space_group_symbol": "P-42_1m"
        },
"Supecell_total_charge": 0,
    "coulombic_energy_unit": "eV"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant