Giter Club home page Giter Club logo

gvaspweb's Introduction

GVaspWeb Manual

GitHub

Table of contents

About GVaspWeb

The Web version of GVasp created by Vue and Flask, which can involve in many kinds of tasks as below:

  • plot optimization process
  • plot electrostatic potential
  • plot band structure
  • plot density of states
  • plot energy barrier

More detailed information about GVasp can see here.

Install

Create Environment

Before install the GVaspWeb, we strongly recommend you to install conda before.

After install conda, create a new environment, e.g. gvasp-web, and install a python (version=3.9), using following command:

conda create -n gvasp-web python=3.9

Install GVasp

  1. Use conda (recommend)

    We now made a conda package (production process can see here) and uploaded to the Anaconda, so you can also install GVasp from it:

    conda install -c hui_zhou -c conda-forge gvasp
    
  2. Use PyPi

    We have made the wheel (production process can see here) and upload to the pypi, you can also install from it:

    python -m pip install gvasp
    

    If the download speed is too slow, we suggest you change the pip mirror by modifying the ~/.pip/pip.conf file.

If you run the gvasp -v and print version information, then you install the GVasp successful ~~

GVasp version x.x.x (Linux-5.10.16.3-microsoft-standard-WSL2-x86_64-with-glibc2.35)

Install Vue

  1. Install nvm (node)

NVM is the most popular NodeJs Management tool, we recommend you to install nodejs with nvm.

Firstly, download the nvm and install it.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

Secondly, install node16 with nvm.

nvm install 16.20.1

Finally, use node16 with nvm.

nvm use 16.20.1
  1. Install Vue
npm install -g @vue/cli
  1. Install modules
cd frontend
npm install .

Code Structure

Requirements

  • Python >= 3.9
  • Cython
  • pybind11
  • numpy
  • matplotlib
  • bash-completion
  • Vue.js
  • Flask

Copyright © 2024 Hui Zhou All rights reserved.

gvaspweb's People

Contributors

rasic2 avatar

Stargazers

Xianyang Zhang avatar

Watchers

 avatar

Forkers

saberg1001

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.