Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (6.5%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: Ying-Ying-Zhang
- License: mit
- Language: Python
- Default Branch: main
- Size: 63.5 KB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 2
Metadata Files
README.md
COFpiler
Build the statistical structure for layered materials by stacking layers following the Maxwell-Boltzmann energy distribution of their stacking modes.
Usage:
python COFpiler.py [-h] [--path PATH] [--data DATA] [--i I] [--o O] [--T T] [--s S] [--mirror MIRROR] [--mplane MPLANE] [--L L] [--M M]
Optional arguments:
-h, --help Show this help message and exit
-data DATA The input file include data needed, form as: form as: the 1st column is the stacking_type, the 2nd is the
Erel (relative energies), the 3rd, 4th and 5th columns are the x, y, z (vector of the shift_vectors)
-i --instr The input structure
-T --tem The experimental synthesize temperature
-path PATH The path where the infile and instr are, the output structure will also save there
-o --outstr_format The output structure format
-s --symmetry The symmetry for the structure, C3, C6 or C4
-m --mirror Enable the consider of mirror shift or not
-mp --mplane The mirror plane for s2 shift
-L L The layer number
-M M The model number
Data file:
The data file saved the relative energies and slipped vectors of all stacking configurations. They can be in xlsx or csv format. The columns should be named as stackingtype, Erel, x, y, z. Please check the dataexample.xlsx for more information
License
MIT © Richard McRichface
Owner
- Name: Yingying Zhang
- Login: Ying-Ying-Zhang
- Kind: user
- Company: @AK-Heine
- Repositories: 1
- Profile: https://github.com/Ying-Ying-Zhang
Citation (CITATION.cff)
cff-version: 1.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Zhang
given-names: Yingying
title: Ying-Ying-Zhang/COFpiler: Version 1.0
version: v1.0
date-released: 2022-02-16