Skip to content

A code for generating crystal stuctures with defects for atomic simulation.

License

Notifications You must be signed in to change notification settings

joshuamhtsang/crystalninja

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

crystalninja README.md

###################

Description

###################

A tool for creating and modifying crystal structures relevant to materials science. Outputs can be used for atomic simulation.

########################

virtualenv setup

########################

This project uses Python virtualenv to simplify environment consistency. Simply

pip3 install -r requirements.txt

to install the needed dependencies. If, during development, you introduce new package dependencies, then ensure you generate a new requirements.txt:

pip3 freeze --user > requirements.txt

##################

How to run

##################

To run, you need to create a *.py script that imports crystal ninja as well as numpy:

import numpy as np
import crystalninja as cn

Look at test.py for an example. To execute, execute in terminal using Python 3:

python3 test.py

About

A code for generating crystal stuctures with defects for atomic simulation.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages