Skip to main content

atomvision

Project description

name alt text codecov PyPI version GitHub tag (latest by date) GitHub code size in bytes GitHub commit activity Downloads

Atomvision

Table of Contents

Introduction

Atomvision is a deep learning framework for atomistic image data.

AtomVision

Installation

First create a conda environment: Install miniconda environment from https://conda.io/miniconda.html Based on your system requirements, you'll get a file something like 'Miniconda3-latest-XYZ'.

Now,

bash Miniconda3-latest-Linux-x86_64.sh (for linux)
bash Miniconda3-latest-MacOSX-x86_64.sh (for Mac)

Download 32/64 bit python 3.6 miniconda exe and install (for windows) Now, let's make a conda environment, say "version", choose other name as you like::

conda create --name vision python=3.8
source activate vision

Now, let's install the package:

Method 1 (using setup.py):

git clone https://github.com/usnistgov/atomvision.git
cd atomvision
python setup.py develop

Method 2 (using pypi):

As an alternate method, AtomVision can also be installed using pip command as follows:

pip install atomvision

Examples

Generating STEM image with convolution approximation: graphene example

stem_conv.py --file_path atomvision/tests/POSCAR --output_path STEM.png

2D-Bravais lattice classification example

This example shows how to classify 2D-lattice (5 Bravais classes) for 2D-materials STM/STEM images.

We will use imagessample_data folder. It was generated with generate_stem.py script. There are two folders train_folder, test_folder with sub-folders 0,1,2,3,4,... for individual classes and they contain images for these classes.

train_classifier_cnn.py --model densenet --train_folder atomvision/sample_data/test_folder --test_folder atomvision/sample_data/test_folder --epochs 5 --batch_size 16

Generating a t-SNE plot

train_tsne.py --data_dir atomvision/sample_data/test_folder

Generative Adversarial Network

train_gan.py --dataset_path atomvision/sample_data/test_folder/0 --epochs 2

Autoencoder

train_autoencoder.py --train_folder atomvision/sample_data/test_folder --test_folder atomvision/sample_data/test_folder --epochs 10

Reference

  1. AtomVision: A machine vision library for atomistic images

  2. The joint automated repository for various integrated simulations (JARVIS) for data-driven materials design

  3. Computational scanning tunneling microscope image database

Please see detailed publications list here.

How to contribute

For detailed instructions, please see Contribution instructions

Correspondence

Please report bugs as Github issues (https://github.com/usnistgov/atomvision/issues) or email to kamal.choudhary@nist.gov.

Funding support

NIST-MGI (https://www.nist.gov/mgi).

Code of conduct

Please see Code of conduct

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atomvision-2023.5.6.tar.gz (53.5 kB view details)

Uploaded Source

Built Distribution

atomvision-2023.5.6-py2.py3-none-any.whl (88.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file atomvision-2023.5.6.tar.gz.

File metadata

  • Download URL: atomvision-2023.5.6.tar.gz
  • Upload date:
  • Size: 53.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.13

File hashes

Hashes for atomvision-2023.5.6.tar.gz
Algorithm Hash digest
SHA256 582bf7538dc53e7e79aa1e0f6e84a8cecf5a43430b7af53251aa11f2e5ac4045
MD5 11c8fc083d7914fe80c289f2215a1b49
BLAKE2b-256 c464490960b1f71c91ee2e8941bf4a78c37aaf3fd28c472d97b1a56fb330690b

See more details on using hashes here.

File details

Details for the file atomvision-2023.5.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for atomvision-2023.5.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3b7a839dce6b3dc098e64b1d68637211cee5dc39f7ddfae5e41bb3ce778f3f4e
MD5 5e7b23d4a2a37201692961ed59b58361
BLAKE2b-256 6e991a5814a927745aa95dafc3e1a2d6ed1835f115fd1cf52eb06c12aa6b077b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page