diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8bb963d..02951a3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,13 +6,12 @@ This changelog contains a non-exhaustive list of new features and notable bug-fi
-# DTWC v0.1.0
+# DTWC v1.0.0
## New features
-* HiGHS solver is added for open-source alternative to Gurobi.
+* HiGHS solver is added for open-source alternative to Gurobi (which is now not necessary for compilation and can be enabled by necessary flags).
* Command line interface is added.
-* Documentation is improved.
-
+* Documentation is improved (Doxygen website).
## Notable Bug-fixes
@@ -44,9 +43,9 @@ This changelog contains a non-exhaustive list of new features and notable bug-fi
* `std::filesystem::path operator+` was unnecessary and removed.
-# DTWC v0.0.2
+# DTWC v0.1.0
-DTWC with a better interface for other people's use.
+A user interface is created for other people's use.
## New features / updates
- Scores file with silhouette score is added.
diff --git a/develop/TODO.md b/develop/TODO.md
index 58b1d55..a3524af 100644
--- a/develop/TODO.md
+++ b/develop/TODO.md
@@ -8,13 +8,15 @@
### Current priority:
+- [ ] Numpy-like arrays for multi-dimensional DTW.
- [ ] If you accidentally compile with amd64_x86 you get bad_alloc due to the insufficient RAM in 32-bit computer. So, put a warning for that.
- [ ] Modernise `*.csv` reading interface, allow for rowwise or columnwise data.
- [x] CMake files arranging:
- [x] HiGHS 1.6.0 does not always work. Also it does not work in debug mode due to iterator level.
- [ ] Commenting
- [ ] MATLAB / Python integration
-- [ ] JOSS paper
+ - [ ] Pybind11 usage for Python integration.
+- [x] JOSS paper
- [ ] Speed up the code
- [ ] GPU programming
- [ ] Lighter and faster DTW cost calculation + make the band from long side so it is more accurate.
@@ -26,8 +28,8 @@
- [ ] Give error message if data could not be loaded.
- Benchmarking:
- [x] UCR_test_2018 is continuing.
- - [ ] USR_dtai.py
- - [ ] TSlearn
+ - [x] USR_dtai.py
+ - [x] TSlearn
- [ ] dtwclust in R
- [ ] Encapsulating Data and related functions in one folder.
- [ ] Open-source solver addition.
@@ -38,7 +40,7 @@
- [x] Doxygen website?
- [x] Remove unnecessary warping functions.
- [ ] Fix warnings. Especially, we should not get warnings from external libraries.
-- [ ] Make Gurobi dependency optional. (Now it cannot be disabled. )
+- [x] Make Gurobi dependency optional. (Now it cannot be disabled. )
- [x] Consider including Eigen library for matrix operations / linear system solution.
- [ ] w based DTW.
- [ ] Reading memoisation matrix distMat from file instead of re-calculating DTW every time.
diff --git a/develop/conventions.md b/develop/conventions.md
index 8331cd7..e32c2e3 100644
--- a/develop/conventions.md
+++ b/develop/conventions.md
@@ -3,6 +3,15 @@
- Do not use "using" in global namespace.
- First include standard headers then our headers.
+## Versioning:
+
+We use semantic versioning with MAJOR.MINOR.PATCH where:
+
+- PATCH: Backwards compatible bug fix without introducing a new feature.
+- MINOR: Backwards compatible new feature.
+- MAJOR: Incompatible changes, especially on API.
+
+See [this link](https://www.youtube.com/watch?v=xvPiZyx0cDc) for a detailed tutorial on versioning.
### Commenting: