Giter VIP home page Giter VIP logo

initial_conditions's Introduction

Initial Conditions (a physics library in Rust)

Build Status Coverage Status

Read the docs

How to use:

Add initial_conditions to your Cargo.toml file:

[dependencies]
initial_conditions = "0.3.0"

Check the crates.io badge above to see which version is the latest

And now use it in your project...

extern crate initial_conditions;

use initial_conditions::kinematics::*;

let w = work::work(/* args */);

Be sure to read the documentation to see what the lib has to offer.

Units

All arguments and return values are implicitly returned in SI units (i.e. radians. Specific units are noted in the documentation)

Project structure

  • Constants are exported directly from src/lib.rs

  • Generalized modules are exported in the main src/lib.rs file

"Generalized", here, means general physics topics: kinematics, electromagnetism, astro, etc.

  • Specific topics are exported from the more general, e.g.:
    // Example structure only
    lib.rs
         |
         | kinematics/
                     |
                     | linear_motion.rs
                     | circular_motion.rs

         | electromag/
                     | magnetism.rs

Capabilities right now (and still being added):

  • Useful constants
  • Kinematics functions

Planned capabilities:

  • Electromagnetism
  • Quantum Mechanics
  • Astro

This is still, very much, a work in progress. The goal of this project is to hold simple (Physics 101) equations, but also more detailed work (n-dimensional physics, integration approximations, etc.). Expect most work to come incrementally, starting from the more simple topics to the more advanced.

Please reach out if something is off or there is any confusion

initial_conditions's People

Contributors

someguynamedmatt avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

gwbres

initial_conditions's Issues

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.