Skip to content

A CLI for getting information about the periodic table of elements.

Notifications You must be signed in to change notification settings

overoxidize/chemicli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

chemicli

About

ChemiCLI is A CLI for getting information about the periodic table of elements, with information somewhat based on the information on PTable, hence some measurements may not be the most precise in terms of the known values for certain properties, i.e the standard atomic weight of hydrogen is [1.00784, 1.00811], but is 1.008 on PTable.

Getting Started

To install ChemiCLI, you'll need to have Rust and Cargo installed. If you don't have them yet, you can install Rust via rustup.

Installation

Run git clone https://github.com/overoxidize/chemicli.git in your terminal to install it.

Usage

chemicli.exe element <ATOMIC_SYMBOL> [OPTIONS]

Arguments

  • <ATOMIC_SYMBOL>: The atomic symbol of the element you want to query.

Options

  • -n, --atomic-number: Include the atomic number of the given element.
  • -w, --atomic-weight: Include the atomic weight of the given element.
  • -l, --energy-levels: Include the energy levels of the given element.
  • -e, --electronegativity: Include the electronegativity of the given element.
  • -s, --series: Include the series of the given element.
  • -d, --date-discovered: Include the discovery date of the given element.
  • -D, --discoverer: Include the discoverer of the given element.
  • -g, --group: Include the group of the given element.
  • -p, --period: Include the period of the given element.
  • -h, --help: Print help.

Examples

  • To query the atomic number of oxygen:

    chemicli.exe element O -n
  • To query the atomic weight and group of iron:

    chemicli.exe element Fe -w -g

Data Source

ChemiCLI uses a local JSON object containing information about the chemical elements. This JSON object is based on the periodic table and is stored within the application.

Roadmap

  • Add mtl command, i.e chem mtl ..., to query about metals.
    • Add sg (subgroup) subcommand, i.e chem mtl -sg for a list of sub-groups of metals, such as alkali earth metals, and lanthanides.

About

A CLI for getting information about the periodic table of elements.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages