Skip to main content

DOS(Density Of States) Plot Smartly in Terminal

Project description

DOSMaster

PyPI GitHub

Program Name: DOSMaster
Author: Youngjun Park (yjpark29@postech.ac.kr)
Inspired by: Jaeseon Kim (CNMD)
Tested by: Changhun Kim (CNMD), Suyun Chae (CNMD)
Description: A smart, highly customizable DOS plotting tool designed for terminal environments.

Version 1.8.3 and above will be publicly released to all CNMD members.


Release History

Version Changes
1.1 Improved loading speed on restart (by Jaeseon Kim)
1.2 Added final data file export feature
1.3 Bug fixes
1.4.2 Refactored for PyPI packaging
1.7.13 Full packaging; added DOS_Sum, Average_DOS, Axis_Optimization, and various performance improvements
1.8.1 Fixed label bugs; added settings save/load, DOS plot save/load, shift_x_axis, extended sequential number input, and legend display toggle
1.8.3 Added ISPIN = 1 calculation support; various bug fixes
1.8.4 License update
1.8.5 Fixed f-orbital error
1.8.8 Fixed ylim optimization error when saving plot in current directory
1.8.10 Fixed f-orbital sum error
1.8.12 Fixed import order error
1.8.15 Fixed graph_editor back feature (suggested by Hyeongbin Park, CNMD)
1.8.16 Added Gaussian smearing feature (contributed by Siyeong Park, CNMD)
1.8.22 Added package version check feature
1.8.24 Fixed PROCAR bug; code generator in development
1.8.25 README update

Features

  1. Add Atom DOS — Add the DOS of a desired atom to the plot.

  2. DOS Projection — Project a specific DOS onto a desired orbital.

  3. Sum DOS — Sum the contributions of selected DOS entries.

  4. Average DOS — Average the contributions of selected DOS entries.

  5. Remove DOS — Remove a specific DOS from the plot.

  6. Plot only Positive/Negative Part — Display only the positive or negative region of the DOS plot.

  7. Edit Graph Style — Customize the graph style to your preference.

    Index Parameter Description
    1 figuresize Overall size of the figure (width × height)
    2 axis_label_fontsize Font size of the x/y axis labels
    3 legend_fontsize Font size of the legend text
    4 ticks_fontsize Font size of the axis tick labels
    5 title_fontsize Font size of the plot title
    6 legend_display Toggle legend visibility on/off
    7 legend_name Default legend label for each DOS entry
    8 legend_name_user User-defined custom legend labels
    9 legend_location Position of the legend within the plot
    10 bbox_to_anchor Fine-tune legend position using anchor coordinates
    11 line_width Line width of the plotted DOS curves
    12 xlim x-axis range (energy range)
    13 ylim y-axis range (DOS intensity range)
    14 positive_plot Toggle display of the positive DOS region
    15 negative_plot Toggle display of the negative DOS region
    16 save_filename Output filename when saving the plot
    17 save_format File format for saving (e.g. png, pdf, svg)
    18 save_dpi Resolution (DPI) of the saved plot
    19 dos_color Color of each DOS curve
    20 ylim_optimization Enable automatic y-axis limit optimization
    21 shift_x_axis Shift the x-axis by a fixed energy offset
    22 smearing Apply Gaussian smearing to smooth the DOS curves
  8. Axis Optimization — Automatically optimize the y-axis limits to fit the current DOS.

  9. Import Global Custom Setting — Load your personal graph settings from the package folder.

  10. Save Global Custom Setting — Save your personal graph settings to the package folder.

  11. Import DOSMaster Plot — Load a previously saved DOSMaster plot from the current directory.

  12. Save DOSMaster Plot — Save the current DOSMaster plot to the current directory.


Installation

Install via PyPI

  1. Installation
pip install dosmaster
  1. Run DOSMaster
dosmaster

Install from Source

  1. Copy the SSH key from your server:
    cat ~/.ssh/id_rsa.pub
    
  2. Go to your GitHub account → SettingsSSH and GPG KeysNew SSH Key, then paste the copied key.
  3. Clone the repository on your server:
    git clone git@github.com:pyj6767/DOSMaster.git
    
  4. Requirements
pip install matplotlib numpy pandas ase colorama
  1. Set Permissions
chmod 775 dosmaster
  1. Run DOSMaster Navigate to the directory containing your DOS calculation results and run:
cd [your DOS calculation folder]
dosmaster

License

DOSMaster is released under the MIT License.

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

dosmaster-1.8.25.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dosmaster-1.8.25-py3-none-any.whl (39.2 kB view details)

Uploaded Python 3

File details

Details for the file dosmaster-1.8.25.tar.gz.

File metadata

  • Download URL: dosmaster-1.8.25.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.13

File hashes

Hashes for dosmaster-1.8.25.tar.gz
Algorithm Hash digest
SHA256 4f4ca8d770eeb90e64cc8689cd6d1a41c07254473429ade18a05728b565bea23
MD5 f4b5a619de968e5983623f1b1af18d2c
BLAKE2b-256 f72097ddb1506911b8a0e3f563a5b0aa15c5dee5d3ee6343b8e1b6d80542aa29

See more details on using hashes here.

File details

Details for the file dosmaster-1.8.25-py3-none-any.whl.

File metadata

  • Download URL: dosmaster-1.8.25-py3-none-any.whl
  • Upload date:
  • Size: 39.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.13

File hashes

Hashes for dosmaster-1.8.25-py3-none-any.whl
Algorithm Hash digest
SHA256 a1c0c565b93eb841856ccb788f008278e1724422e533e62144f9e999146aa314
MD5 18bbe19b81dc77d217a7d38646e9844f
BLAKE2b-256 4286aeb362b6258613e1bf53f6ea5f4127b0fde4cbcbcc7a6b5340c58cc3bf2e

See more details on using hashes here.

Supported by

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