Skip to content

Commit

Permalink
publish release v1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
teasit committed Jun 15, 2022
1 parent 37a2713 commit 84edaa6
Show file tree
Hide file tree
Showing 10 changed files with 13 additions and 38 deletions.
20 changes: 1 addition & 19 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,3 @@
# Changelog

- Renaming of library and functions due to trademark issues
- Added example measurement data (de-identified and obscured TTC data)
- Updated FSAE TTC interactive example to use new data
- Updated unit tests
- Convenience changes:
- New: Wrapper for `magicformula.v62.eval()` function. Can now call method `eval()` on `magicformula.v62.Model` objects. Example:

```matlab
model = magicformula.v62.Model();
model.importTyrePropertiesFile(file)
[FX, FY] = model.eval(SA, SX, IA, IP, FZ, 0);
```

- New: Can now instantiate `magicformula.v62.Model` directly with TIR file, without having to call `importTyrePropertiesFile()` method. Example:

```matlab
model = magicformula.v62.Model(file);
[FX, FY] = model.eval(SA, SX, IA, IP, FZ, 0);
```
- Renaming of library and functions
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
# Magic Formula Tyre Library

[![View on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://de.mathworks.com/matlabcentral/fileexchange/110955-mftyrelibrary)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/teasit/mftyre-matlab-library)](https://github.com/teasit/mftyre-matlab-library/releases/latest)

![Social Preview Image](./doc/images/tyre_icon_socialpreview.png)
[![View on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://de.mathworks.com/matlabcentral/fileexchange/110955)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/teasit/magic-formula-tyre-library)](https://github.com/teasit/magic-formula-tyre-library/releases/latest)

```matlab
[Fx,Fy] = magicformula.v62.eval(p,slipangl,longslip,inclangl,inflpres,FZW,tyreSide)
```

- Computationally efficient MF-Tyre functions
- Computationally efficient Magic Formula tyre model functions
- Code generation compatible
- Automatically fit MF-Tyre models to data
- Automatically fit Magic Formula tyre models to data
- TIR import/export (Tyre Property File format)
- TYDEX import (Tyre Data Exchange format)

![Fitting Example](doc/images/mftyrelib_fit_example.png)
![Fitting Example](doc/images/fit_example.png)

## Requirements

Expand All @@ -28,7 +26,7 @@
There are several ways:

- Download latest Release from [MATLAB File Exchange](https://de.mathworks.com/matlabcentral/fileexchange/110955)
- Download latest Release from [GitHub](https://github.com/teasit/mftyre-matlab-library/releases)
- Download latest Release from [GitHub](https://github.com/teasit/magic-formula-tyre-library/releases)
- Clone using Git and integrate into your projects using a [Project Reference](https://de.mathworks.com/help/simulink/ug/add-or-remove-a-reference-to-another-project.html)

## Usage and Examples
Expand All @@ -39,11 +37,11 @@ To get started with interactive examples, open the MATLAB live script
You can find further examples in the [`doc/examples`](./doc/examples) folder.

I also created an open-source GUI application in MATLAB for interactive fitting
of MF-Tyre models to measurement data.
of Magic Formula tyre models to measurement data.
It uses this library as a submodule, meaning that fitted parameter sets with the GUI can
be used with the equations provided by this CLI library.
You can find it here:
[MF-Tyre MATLAB Tool](https://github.com/teasit/mftyre-matlab-tool)!
[Link to GUI](https://github.com/teasit/magic-formula-tyre-tool)!

## Motivation

Expand Down Expand Up @@ -77,7 +75,7 @@ de-identified and obscured data for demonstration purposes.

## Known Issues, Notes and Bugs

- Currently only MFTyre version 6.1.2 (62) is implemented
- Currently only Magic Formula version 6.1.2 (62) is implemented
- Of v6.1.2 the turn slip parameters have been reduced to constant parameters
(noted by greek letter zeta in Pacejka's book). To remove the influence of
these parameters, simply set them to unity (=1). The default parameter
Expand All @@ -86,5 +84,4 @@ de-identified and obscured data for demonstration purposes.
friction coefficient) to remove dependency on speed as input. Might be
added as an alternative implementation in the future.
- In some sub-equations a few scaling factors were not implemented
(as they could not be attributed to a parameter in the MFTyre/MFSwift manual).
- Self-aligning torque is not calculated/implemented (MZW).
2 changes: 1 addition & 1 deletion ToolboxPackager.prj
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<param.summary>MATLAB library for Magic Formula Tyre Modeling</param.summary>
<param.description />
<param.screenshot>${PROJECT_ROOT}\doc\images\MFTyreLibrary_PackageImage.png</param.screenshot>
<param.version>1.1.1</param.version>
<param.version>1.1.2</param.version>
<param.output>${PROJECT_ROOT}\MagicFormulaTyreLibrary.mltbx</param.output>
<param.products.name />
<param.products.id />
Expand Down
File renamed without changes
Binary file removed doc/images/tyre_icon_socialpreview.png
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<?xml version='1.0' encoding='UTF-8'?>
<Info location="fit_example.png" type="File" />

This file was deleted.

This file was deleted.

This file was deleted.

0 comments on commit 84edaa6

Please sign in to comment.