Skip to content

Commit 5fed37a

Browse files
rdesarzrdesarz
committed
Rename project
1 parent 5172401 commit 5fed37a

10 files changed

+37
-37
lines changed

‎Cargo.lock

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[package]
2-
name = "control-sys-rs"
2+
name = "control_sys"
33
version = "0.1.0"
44
edition = "2021"
55

6-
description = "Control-sys.rs. A Control System library implemented in Rust to design and analyze control systems."
6+
description = "A Control System library implemented in Rust to design and analyze control systems."
77
authors = ["Romain Desarzens"]
88
readme = "README.md"
99

‎Dockerfile

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ RUN rustup component add rustfmt
1616
RUN cargo install cargo-generate
1717

1818
# Copy the project inside the image
19-
COPY . /root/control-sys-rs
19+
COPY . /root/control_sys
2020

21-
WORKDIR /root/control-sys-rs
21+
WORKDIR /root/control_sys

‎README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# control-sys.rs
1+
# control_sys, a control system library written in Rust
22

3-
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/rdesarz/control-sys-rs/rust.yml)
3+
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/rdesarz/control_sys_rs/rust.yml)
44

5-
**Control-sys.rs** is a control system library written in Rust. It implements tools to represent and analyze LTI systems using state-space model.
5+
**control_sys** is a control system library written in Rust. It implements tools to represent and analyze LTI systems using state-space model.
66

77
## Examples
88

@@ -12,7 +12,7 @@ A continuous state space model can be defined with `ContinuousStateSpaceModel`.
1212

1313
```rust
1414
use nalgebra as na;
15-
use control_sys_rs::model;
15+
use control_sys::model;
1616

1717
// DC motor parameters
1818
let b = 0.1f64;
@@ -38,7 +38,7 @@ A `DiscreteStateSpaceModel` can be built from a continuous one. You then need to
3838

3939
```rust
4040
use nalgebra as na;
41-
use control_sys_rs::model;
41+
use control_sys::model;
4242

4343
// DC motor parameters
4444
let b = 0.1f64;
@@ -67,7 +67,7 @@ You can compute the step response of a system. For a discrete system, the simula
6767

6868
```rust
6969
use nalgebra as na;
70-
use control_sys_rs::{model, simulator};
70+
use control_sys::{model, simulator};
7171

7272
// DC motor parameters
7373
let b = 0.1f64;
@@ -101,7 +101,7 @@ You can also compute the step response for a continuous model. You will need to
101101

102102
```rust
103103
use nalgebra as na;
104-
use control_sys_rs::{model, simulator};
104+
use control_sys::{model, simulator};
105105

106106
// DC motor parameters
107107
let b = 0.1f64;
@@ -136,7 +136,7 @@ The controllability of a system can be evaluated using the `is_ss_controllable`
136136

137137
```rust
138138
use nalgebra as na;
139-
use control_sys_rs::{model, analysis};
139+
use control_sys::{model, analysis};
140140

141141
let ss_model = model::DiscreteStateSpaceModel::from_matrices(
142142
&nalgebra::dmatrix![1.0, -2.0;

‎docker-compose.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: "3.1"
22
services:
3-
control-sys-rs:
4-
container_name: control-sys-rs
3+
control_sys:
4+
container_name: control_sys
55
build:
66
context: .
77
restart: "unless-stopped"

‎examples/controllability.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
use control_sys_rs::analysis;
2-
use control_sys_rs::model;
1+
use control_sys::analysis;
2+
use control_sys::model;
33

44
extern crate nalgebra as na;
55

‎examples/step_response.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
use control_sys_rs::model;
2-
use control_sys_rs::model::Pole;
3-
use control_sys_rs::simulator;
1+
use control_sys::model;
2+
use control_sys::model::Pole;
3+
use control_sys::simulator;
44

55
use plotters::prelude::*;
66

@@ -15,7 +15,7 @@ pub mod two_spring_damper_mass {
1515

1616
use std::default::Default;
1717

18-
use control_sys_rs::model::DiscreteStateSpaceModel;
18+
use control_sys::model::DiscreteStateSpaceModel;
1919

2020
pub struct Parameters {
2121
m1: f64,
@@ -63,7 +63,7 @@ pub mod two_spring_damper_mass {
6363
}
6464

6565
pub mod dc_motor {
66-
use control_sys_rs::model::DiscreteStateSpaceModel;
66+
use control_sys::model::DiscreteStateSpaceModel;
6767
use std::default::Default;
6868

6969
pub struct Parameters {

‎src/analysis.rs

+6-6
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ use crate::model::StateSpaceModel;
2424
/// # Examples
2525
///
2626
/// ```
27-
/// use control_sys_rs::analysis;
27+
/// use control_sys::analysis;
2828
///
2929
/// let mat_a = nalgebra::dmatrix![1.0, -2.0;
3030
/// 2.0, 1.0];
@@ -73,8 +73,8 @@ pub fn compute_controllability_matrix(
7373
/// # Examples
7474
///
7575
/// ```
76-
/// use control_sys_rs::analysis;
77-
/// use control_sys_rs::model;
76+
/// use control_sys::analysis;
77+
/// use control_sys::model;
7878
///
7979
/// let ss_model = model::DiscreteStateSpaceModel::from_matrices(
8080
/// &nalgebra::dmatrix![1.0, -2.0;
@@ -121,7 +121,7 @@ pub fn is_ss_controllable<T: StateSpaceModel>(model: &T) -> (bool, na::DMatrix<f
121121
/// # Examples
122122
///
123123
/// ```
124-
/// use control_sys_rs::analysis;
124+
/// use control_sys::analysis;
125125
///
126126
/// let mat_a = nalgebra::dmatrix![1.0, -2.0;
127127
/// 2.0, 1.0];
@@ -169,8 +169,8 @@ pub fn compute_observability_matrix(
169169
/// # Examples
170170
///
171171
/// ```
172-
/// use control_sys_rs::analysis;
173-
/// use control_sys_rs::model;
172+
/// use control_sys::analysis;
173+
/// use control_sys::model;
174174
///
175175
/// let ss_model = model::DiscreteStateSpaceModel::from_matrices(
176176
/// &nalgebra::dmatrix![1.0, -2.0;

‎src/lib.rs

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
#![warn(missing_docs)]
22
/*!
3-
# control-sys.rs
3+
# control_sys
44
5-
**Control-sys.rs** is a control system library written in Rust. It implements tools to represent and analyze LTI systems using state-space model.
5+
**control_sys** is a control system library written in Rust. It implements tools to represent and analyze LTI systems using state-space model.
66
77
## Examples
88
@@ -12,7 +12,7 @@ A continuous state space model can be defined with `ContinuousStateSpaceModel`.
1212
1313
```rust
1414
use nalgebra as na;
15-
use control_sys_rs::model;
15+
use control_sys::model;
1616
1717
// DC motor parameters
1818
let b = 0.1f64;
@@ -38,7 +38,7 @@ A `DiscreteStateSpaceModel` can be built from a continuous one. You then need to
3838
3939
```rust
4040
use nalgebra as na;
41-
use control_sys_rs::model;
41+
use control_sys::model;
4242
4343
// DC motor parameters
4444
let b = 0.1f64;
@@ -67,7 +67,7 @@ You can compute the step response of a system. For a discrete system, the simula
6767
6868
```rust
6969
use nalgebra as na;
70-
use control_sys_rs::{model, simulator};
70+
use control_sys::{model, simulator};
7171
7272
// DC motor parameters
7373
let b = 0.1f64;
@@ -101,7 +101,7 @@ You can also compute the step response for a continuous model. You will need to
101101
102102
```rust
103103
use nalgebra as na;
104-
use control_sys_rs::{model, simulator};
104+
use control_sys::{model, simulator};
105105
106106
// DC motor parameters
107107
let b = 0.1f64;
@@ -136,7 +136,7 @@ The controllability of a system can be evaluated using the `is_ss_controllable`
136136
137137
```rust
138138
use nalgebra as na;
139-
use control_sys_rs::{model, analysis};
139+
use control_sys::{model, analysis};
140140
141141
let ss_model = model::DiscreteStateSpaceModel::from_matrices(
142142
&nalgebra::dmatrix![1.0, -2.0;

‎src/model.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ pub trait StateSpaceModel {
2727
/// # Examples
2828
///
2929
/// ```
30-
/// use control_sys_rs::model::Discrete;
30+
/// use control_sys::model::Discrete;
3131
///
3232
/// struct MyDiscreteSystem {
3333
/// sampling_dt: f64,
@@ -54,7 +54,7 @@ pub trait Discrete {
5454
///
5555
/// ```
5656
/// use nalgebra as na;
57-
/// use control_sys_rs::model::Pole;
57+
/// use control_sys::model::Pole;
5858
///
5959
/// struct MySystem;
6060
///

0 commit comments

Comments
 (0)