Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Contents.m file #25

Merged
merged 2 commits into from
Nov 9, 2020
Merged

Add Contents.m file #25

merged 2 commits into from
Nov 9, 2020

Conversation

IshaanDesai
Copy link
Member

@IshaanDesai IshaanDesai commented Oct 14, 2020

This PR adds a Contents.m file for the bindings. This file is used to store version number and also information which the user can query with the help command in MATLAB.
After compiling the bindings the output of ver is as follows:

>> ver
-----------------------------------------------------------------------------------------------------
MATLAB Version: 9.5.0.944444 (R2018b)
MATLAB License Number: XXXXXX
Operating System: XXXXXX
Java Version: XXXX
-----------------------------------------------------------------------------------------------------
MATLAB                                                Version 9.5         (R2018b)
Simulink                                              Version 9.2         (R2018b)
Communications Toolbox                                Version 7.0         (R2018b)
Control System Toolbox                                Version 10.5        (R2018b)
DSP System Toolbox                                    Version 9.7         (R2018b)
Image Processing Toolbox                              Version 10.3        (R2018b)
MATLAB-bindings for coupling library preCICE          Version 2.1.0.1     (R2018b)
Optimization Toolbox                                  Version 8.2         (R2018b)
Signal Processing Toolbox                             Version 8.1         (R2018b)
Simulink Control Design                               Version 5.2         (R2018b)
Symbolic Math Toolbox                                 Version 8.2         (R2018b)

It can be seen that the MATLAB-bindings and the version number are now included in the list.
Unfortunately adding the Contents file to the +precice folder to enable a query like ver precice does not work and throws the error:

>> ver precice
-----------------------------------------------------------------------------------------------------
MATLAB Version: 9.5.0.944444 (R2018b)
MATLAB License Number: 722433
Operating System: Linux 4.15.0-118-generic #119-Ubuntu SMP Tue Sep 8 12:30:01 UTC 2020 x86_64
Java Version: Java 1.8.0_152-b16 with Oracle Corporation Java HotSpot(TM) 64-Bit Server VM mixed mode
-----------------------------------------------------------------------------------------------------
Warning: No properly formatted Contents.m file was found for 'precice'. 
> In ver (line 58) 

This has been resolved yet. Putting a Contents file in the main folder of the bindings is the simplest working solution yet to store the Version number.
This PR closes #24

@IshaanDesai IshaanDesai self-assigned this Oct 14, 2020
@IshaanDesai IshaanDesai added the documentation Improvements or additions to documentation label Oct 14, 2020
Copy link
Member

@BenjaminRodenberg BenjaminRodenberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a good solution to me (for the sake of closing #24). Not perfect, since the ver precice would be a nice feature and I assume Contents.m provides more features that might be useful, but good enough for now.

@IshaanDesai IshaanDesai merged commit 901dd4c into develop Nov 9, 2020
IshaanDesai added a commit that referenced this pull request Nov 9, 2020
* Fix typo

* Add data transfer to solverdummy (#20)

* Add Contents.m file (#25)

* Adding Contents.m file to store version

* Adding all tested versions of MATLAB to Contents file

* Bump version

Co-authored-by: Benjamin Rüth <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add version information to repository/code
2 participants