Giter Site home page Giter Site logo

edualb / godmitri Goto Github PK

View Code? Open in Web Editor NEW
3.0 2.0 0.0 155 KB

This project provides utilities for chemistry. The name of the project was inspired by periodic table creator Dmitri Ivanovic Mendeleev name.

License: MIT License

Go 100.00%
chemistry golang library cheminformatics code4lib bioinformatics scientific

godmitri's Introduction

Build Status

Icon made by Freepik from www.flaticon.com

Table Of Contents:

Introduction

Installation

Getting start

Introduction

This project provides utilities for general chemistry. The name of the project was inspired by periodic table creator Dmitri Ivanovic Mendeleev.

Key features:

  • Get all elements properties from the periodic table โœ”๏ธ

If you want to contribute with a new feature or found out some bug which you can solve, check our contributing guideline

Installation

  • init the go module in your project

    $ go mod init example.com/myProject
    
  • Just import the godmitri library in your project

    import "github.com/edualb/godmitri/element"

Getting start

package main

import (
	"fmt"

	"github.com/edualb/godmitri/element"
)

func main() {
    // Creates an instance of Aluminium
	a := element.Aluminium{}

    // Prints the atomic weight from aluminium
	fmt.Printf("%f\n", a.GetAtomicWeight())
}

godmitri's People

Contributors

edualb avatar

Stargazers

Luciano Stuart avatar Oliverfelt avatar  avatar

Watchers

James Cloos avatar  avatar

godmitri's Issues

Update documentation

We need to update our README.md. For that, I thought some things like that:

  • A logo for godmitri library
  • CI status for godmitri library (I will provide it)
  • Installation guide
  • A list of features that godmitri provides
  • Getting start
  • How to contribute
  • Code of conduct
  • Issue template
  • Pull request template

Add periodic table elements

We need to provide periodic table elements. So to do this, there is a folder called element which contains an interface like that:

type Element interface {
	GetPeriod() string
	GetGroup() string
	GetCategory() string
	GetName() string
	GetSimbol() string
	GetAtomicNumber() int
	GetAtomicWeight() float32
}

From that, you can build new elements, we have as an example the Helium element which was based on IUPAC periodic table

If you need more examples, I recommend accessing the ptable website

Elements:

  • 1st Period

    • Hydrogen
    • Helium
  • 2nd Period

    • Lithium
    • Beryllium
    • Boron
    • Carbon
    • Nitrogen
    • Oxygen
    • Fluorine
    • Neon
  • 3rd Period

    • Sodium
    • Magnesium
    • Aluminium
    • Silicon
    • Phosphorus
    • Sulfur
    • Chlorine
    • Argon
  • 4th Period

    • Potassium
    • Calcium
    • Scandium
    • Titanium
    • Vanadium
    • Chromium
    • Manganese
    • Iron
    • Cobalt
    • Nickel
    • Copper
    • Zinc
    • Gallium
    • Germanium
    • Arsenic
    • Selenium
    • Bromine
    • Krypton
  • 5th Period

    • Rubidium
    • Strontium
    • Yttrium
    • Zirconium
    • Niobium
    • Molybdenum
    • Technetium
    • Ruthenium
    • Rhodium
    • Palladium
    • Silver
    • Cadmium
    • Indium
    • Tin
    • Antimony
    • Tellurium
    • Iodine
    • Xenon
  • 6th Period

    • Caesium
    • Barium
    • Lanthanum
    • Cerium
    • Praseodymium
    • Neodymium
    • Promethium
    • Samarium
    • Europium
    • Gadolinium
    • Terbium
    • Dysprosium
    • Holmium
    • Erbium
    • Thulium
    • Ytterbium
    • Lutetium
    • Hafnium
    • Tantalum
    • Tungsten
    • Rhenium
    • Osmium
    • Iridium
    • Platinum
    • Gold
    • Mercury
    • Thallium
    • Lead
    • Bismuth
    • Polonium
    • Astatine
    • Radon
  • 7th Period

    • Francium
    • Radium
    • Actinium
    • Thorium
    • Protactinium
    • Uranium
    • Neptunium
    • Plutonium
    • Americium
    • Curium
    • Berkelium
    • Californium
    • Einsteinium
    • Fermium
    • Mendelevium
    • Nobelium
    • Lawrencium
    • Rutherfordium
    • Dubnium
    • Seaborgium
    • Bohrium
    • Hassium
    • Meitnerium
    • Darmstadtium
    • Roentgenium
    • Copernicium
    • Nihonium
    • Flerovium
    • Moscovium
    • Livermorium
    • Tennessine
    • Oganesson

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.