#running #duration #health #race #planning #sport #runner

librunner

Rust library to assist runners on planning their workouts, races, and improve their health

9 releases (breaking)

0.7.0 Mar 29, 2024
0.6.0 Jun 17, 2023
0.5.0 Jun 10, 2023
0.4.0 May 23, 2023
0.1.0 May 3, 2023

#98 in Science

Download history 4/week @ 2024-03-15 173/week @ 2024-03-29 13/week @ 2024-04-05 1/week @ 2024-04-12 3/week @ 2024-05-17 1/week @ 2024-05-24

325 downloads per month

Apache-2.0

35KB
452 lines

Lib Runner

Rust package to assist runners in planning workouts, completing races, and improving health.

Usage

Let's go through these quick steps to get started with LibRunner:

  1. visit https://rustup.rs and install rustup, an installer for the programming language Rust. Once installed, update and check the toolchain:

    $ rustup update
    $ rustc --version
    $ cargo --version
    
  2. create your new running application:

    $ cargo new runningapp
    
  3. a folder called runningapp is created. Go into it and run the project:

    $ cd runningapp
    $ cargo run
    
  4. it prints "Hello World", meaning you have a working code to start from. Open the project in your favorite code editor and make two changes:

    4.1. add LibRunner to the project's dependencies:

    $ cargo add librunner
    

    It adds a new dependency to your Cargo.toml file:

    [dependencies]
    librunner = "0.6.0"
    

    4.2. replace the content of the file src/main.rs with the code below:

    use std::time::Duration;
    use librunner::running::Race;
    use librunner::running::Running;
    use librunner::running::MetricRace;
    use librunner::running::ImperialRace;
    use librunner::running::MetricRunning;
    use librunner::running::ImperialRunning;
    use librunner::utils::converter;
    use librunner::utils::formatter;
    
    fn main() {
        let duration = converter::to_duration(4, 0, 0); // 04:00:00
        let m_marathon: MetricRace = Race::new(42195);
        let m_running: MetricRunning = Running::new(duration);
    
        println!("The pace to run {}km in {}h is approximately {}/km at {:.2}km/h", 
            converter::to_km(m_marathon.distance),
            formatter::format_duration(m_running.duration()), 
            formatter::format_duration(m_running.average_pace(&m_marathon)),
            converter::to_km_h(m_running.speed(&m_marathon)));
    
        let i_marathon: ImperialRace = Race::new(46112);
        let i_running: ImperialRunning = Running::new(duration);
    
        println!("The pace to run {} miles in {}h is approximately {}/mile at {:.2}mph", 
            converter::to_mile(i_marathon.distance), 
            formatter::format_duration(i_running.duration()),
            formatter::format_duration(i_running.average_pace(&i_marathon)),
            converter::to_mph(i_running.speed(&i_marathon)));
    }
    
  5. then run the project again:

    $ cargo run
    

    which generates the following output:

    The pace to run 42.195km in 04:00:00h is approximately 05:41/km at 10.55km/h
    The pace to run 26.2 miles in 04:00:00h is approximately 09:09/mile at 6.55mph
    

License

LibRunner is used under the terms of the Apache License version 2.0.

No runtime deps