Skip to content

Commit 1f34654

Browse files
committed
ci: cleanup
1 parent e3abf1c commit 1f34654

File tree

7 files changed

+43
-21
lines changed

7 files changed

+43
-21
lines changed

.appveyor.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,11 @@ after_build:
6060
- mkdir deployment
6161
# change the name of the exe, zip it and copy the zip to the deployment folders
6262
- cd %APPVEYOR_BUILD_FOLDER%\install
63-
- 7z a %EXE_EXTENDED_NAME%.zip bin\* -r # zip
63+
- cd bin
64+
- 7z a %EXE_EXTENDED_NAME%.zip * # zip
65+
- cd ..
6466
- 7z a %LIB_EXTENDED_NAME%.zip lib\* lib_static\* lib_shared\* include\* # zip
65-
- copy %APPVEYOR_BUILD_FOLDER%\install\%EXE_EXTENDED_NAME%.zip %APPVEYOR_BUILD_FOLDER%\deployment\%EXE_EXTENDED_NAME%.zip
67+
- copy %APPVEYOR_BUILD_FOLDER%\install\bin\%EXE_EXTENDED_NAME%.zip %APPVEYOR_BUILD_FOLDER%\deployment\%EXE_EXTENDED_NAME%.zip
6668
- copy %APPVEYOR_BUILD_FOLDER%\install\%LIB_EXTENDED_NAME%.zip %APPVEYOR_BUILD_FOLDER%\deployment\%LIB_EXTENDED_NAME%.zip
6769

6870
test_script:

.travis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@ deploy:
149149
provider: releases
150150
api_key:
151151
secure: ${GH_PERSONAL_ACCESS_TOKEN}
152-
file_glob: ON
152+
file_glob: true
153153
file: deployment/*
154-
skip_cleanup: ON
154+
skip_cleanup: true
155155
on:
156156
tags: ON
157157
condition: ${DEPLOY_BUILD} == "ON" # I guess I have to pick one compiler

CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ MESSAGE("USE_VNL: " ${USE_VNL})
135135
MESSAGE("USE_PRIVATE_NR2: " ${USE_PRIVATE_NR2})
136136
#MESSAGE("USE_NR2: " ${USE_NR2})
137137
#MESSAGE("USE_NR3: " ${USE_NR3})
138+
MESSAGE("USE_LMFIT: " ${USE_LMFIT})
138139
MESSAGE("USE_YAML: " ${USE_YAML})
139140
MESSAGE("BUILD_SHARED_LIBS: " ${BUILD_SHARED_LIBS})
140141
MESSAGE("CMAKE_INSTALL_PREFIX: " ${CMAKE_INSTALL_PREFIX})

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Tomato
22

33
A library to calculate parametric maps in MRI. It contains ShMOLLI implementation as in [this article](https://jcmr-online.biomedcentral.com/articles/10.1186/1532-429X-12-69).
4-
**Github** repository can be found [here](https://github.com/MRKonrad/tomato).
5-
**Documentation** in doxygen can be found [here](https://mrkonrad.github.io/tomato/html).
4+
* **Github** repository can be found [here](https://github.com/MRKonrad/tomato).
5+
* **Documentation** in doxygen can be found [here](https://mrkonrad.github.io/tomato/html).
66

77
| System | Status |
88
|-------------------------------------------|:------------------------------------------------------------------:|
@@ -13,25 +13,26 @@ A library to calculate parametric maps in MRI. It contains ShMOLLI implementatio
1313
| [Test coverage - Codecov][codecov_link] | [![codecov][codecov_badge]][codecov_link] |
1414
| [Downloads][downloads_link] | [![GitHub Releases (by Release)][downloads_badge]][downloads_link] |
1515

16-
17-
# Usage
16+
## Usage
1817

1918
* App - download the latest version of `TomatoExe` from the [Releases][downloads_link] page and follow the youtube tutorial below
2019
[![Tomato tutorial](https://img.youtube.com/vi/0tzNZNiZh18/0.jpg)](https://www.youtube.com/watch?v=0tzNZNiZh18)
20+
2121
* Lib - download the latest version of `TomatoLib` from the [Releases][downloads_link] page
22+
2223
* Code - if you want to build the code please take a look at the scripts in the `scriptsBuild` and the continuous integrations scripts `.appveyor.yml` and `travis.yml`
2324

2425
## Tomato and Numerical Recipes
2526

2627
**Important**
2728
Original ShMOLLI (and based on it Tomato) uses code based on Numerical Recipes book. Due to Numerical Recipes licence I cannot share this part of the code online. Please contact me if you would like to use this part of the code. To make up for this limitation we provide a number of alternative fitting procedures.
2829

29-
# Troubleshooting
30+
## Troubleshooting
3031

3132
* missing msvcp140.dll
3233
Download <https://www.microsoft.com/en-us/download/details.aspx?id=48145> as suggested in <https://stackoverflow.com/questions/32998902/msvcp140-dll-missing>
3334

34-
# Software Requirements Specification
35+
## Software Requirements Specification
3536

3637
1. Calculate ShMOLLI with exactly the same results as these from the previous implementation.
3738
2. API for easily choosing
@@ -45,20 +46,21 @@ Download <https://www.microsoft.com/en-us/download/details.aspx?id=48145> as sug
4546
5. Fast calculation.
4647
6. Easily interfaced to calculation environments MATLAB, IDL and Python.
4748

48-
# Contributing and code of conduct
49+
## Contributing and code of conduct
4950

5051
Please see [contributing.md](contributing.md) and [codeofconduct.md](codeofconduct.md).
5152

52-
# Notes
53+
## Notes
5354

5455
* **Continuous integration** was tested [in this repo](https://github.com/MRKonrad/ContinousIntegrationPlayground).
5556
* **Gitmodules**: after `git clone` run `git submodule update --init --recursive` to get the submodules code.
5657
* It would be nice to follow [CppCoreGuidlines](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md) as far as C++98 allows.
5758
* Maybe I can write a script for github releases with [github releases REST api](https://developer.github.com/v3/repos/releases/#create-a-release) and [curl REST api](http://www.codingpedia.org/ama/how-to-test-a-rest-api-from-command-line-with-curl/#12_HEAD_requests)?
5859
* LMFIT - somehow windows does not like the static library, so the dynamic is used
5960

60-
# TODO:
61+
## TODO
6162

63+
* Deployment: exe and lib in one zip
6264
* output SNR maps
6365
* make sure SNR and nAmoebaCalls is the same as in Shmolli
6466
* fix downloadITK_linux_osx

codeofconduct.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,14 @@ include:
2222

2323
Examples of unacceptable behavior by participants include:
2424

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
25+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
26+
2727
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
2829
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
30+
31+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
32+
3133
* Other conduct which could reasonably be considered inappropriate in a
3234
professional setting
3335

@@ -70,7 +72,7 @@ members of the project's leadership.
7072
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
7173
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
7274

73-
[homepage]: <https://www.contributor-covenant.org>
74-
7575
For answers to common questions about this code of conduct, see
7676
<https://www.contributor-covenant.org/faq>
77+
78+
[homepage]: <https://www.contributor-covenant.org>

CONTRIBUTING.md renamed to contributing.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
# Contributing to TOMATO
2+
23
We want to make contributing to this project as easy and transparent as
34
possible.
45

56
## Our Development Process
7+
68
We use GitHub to sync code to and from our internal repository. We'll use GitHub
79
to track issues and feature requests, as well as accept pull requests.
810

911
## Issues
12+
1013
We use GitHub issues to track public bugs. Please ensure your description is
1114
clear and has sufficient instructions to be able to reproduce the issue.
1215

1316
## Report bugs using Github's [issues](https://github.com/MRKonrad/tomato/issues)
17+
1418
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
1519

1620

1721
## Pull Requests
22+
1823
We actively welcome your pull requests.
1924

2025
1. Fork the repo and create your branch from `master`.
@@ -25,26 +30,34 @@ We actively welcome your pull requests.
2530
6. Issue that pull request!
2631

2732
## Any contributions you make will be under the MIT Software License
33+
2834
In short, when you submit code changes, your submissions are understood to be under the same
2935
[MIT License](http://choosealicense.com/licenses/mit/) that covers the project.
3036
Feel free to contact the maintainers if that's a concern.
3137

3238
## Coding style
39+
3340
* Write code compatible with C++98
41+
3442
* Use underscore (`_variable`) in the name of a class member variable.
43+
3544
* C++98 does not allow me to use constructor delegation. Using methods like `setAllPointersToNull()` to make up for it.
45+
3646
* Order of methods in a class definition:
3747
* functional (calculation, helpers etc)
3848
* getters/setters
3949
* disp()
4050
* constructors/destructors
51+
4152
* In **copy constructors** copy primitive types, set all pointers to zero.
4253

4354
## License
55+
4456
By contributing to Draft.js, you agree that your contributions will be licensed
4557
under its BSD license.
4658

4759
## References
60+
4861
This document was adapted from the open-source contribution guidelines for
4962
[Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
5063
and [qMRLab](https://github.com/qMRLab/qMRLab/blob/master/CONTRIBUTING.md).

notepad.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Different results from the configurations
1+
# NOTES
2+
3+
## Different results from the configurations
24

35
parameter_to_map: T1_SHMOLLI
46
functions_type: **FunctionsBasic/FunctionsShmolli**
@@ -22,6 +24,6 @@ start_point_calc_method: **Default/StartPointSHMOLLI**
2224
Default: 2.2s and wrong results
2325
StartPointSHMOLLI: 10s and seemingly correct results
2426

25-
# 5 vs 7 samples
27+
## 5 vs 7 samples
2628

2729
5 samples are calculated way slower. Maybe playing with fmax and maxIter would reduce the time?

0 commit comments

Comments
 (0)