Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 1.77 KB

README.md

File metadata and controls

45 lines (36 loc) · 1.77 KB

Joules Logo

Ruby Badge

Gem Version Build Status Inline Docs

About

Joules is a library (gem) for providing simple Physics formulas in kinematics, forces, waves, electricity, and so much more. A selection of fundamental constants are also provided. It is written entirely in Ruby.

Note: For library download, please visit https://www.rubygems.org/gems/joules.

Library Compilation

gem build joules.gemspec

Library Installation

gem install joules-0.4.4.gem

Library Import

require 'joules'

Usage

Simple Method Call

Joules.gravitational_potential_energy(0.5, 6)

This would return 29.43.

Method Composition

Joules.power(Joules.work_done(40, 2.34), 4)

This would return 23.4.

Note: For documentation on usage of methods and constants, please visit http://www.rubydoc.info/gems/joules/.

Contributing

In order to make Joules better, everyone is encouraged to help improve this project. Before diving into the code, please familiarize yourself with the Guide to Contributing.

License