Skip to content

Commit

Permalink
Remove key features from quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
NinadBhat committed Sep 11, 2024
1 parent debdbc3 commit f590cfe
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,6 @@

Welcome to the atomID package quickstart guide! This guide will help you get started with using the `AnnotateCrystal` class for annotating crystal structures and defects. Follow the steps below to begin.

## Key Features

- **Multi-format Data Input**: Supports data import from multiple commonly used formats, such as CIF, POSCAR, and LAMMPS, ensuring compatibility across various modelling tools and workflows.
- **Crystal Structure Identification**: Utilises Common Neighbour Analysis to accurately identify crystal structures within different lattices.
- **Defect Detection and Characterisation**: Applies Wigner-Seitz analysis to detect and categorise various types of lattice defects.
- **Defect Concentration Calculation**: Computes the concentration of different point defects.
- **Knowledge Graph Creation**: Generates a knowledge graph for crystal structures using the Computational Material Sample Ontology (CMSO), which can be exported and stored in Turtle (TTL) format, enabling sharing and complex querying on the data.

## Installation

First, ensure you have the `atomID` package installed. You can install it via pip:
Expand Down

0 comments on commit f590cfe

Please sign in to comment.