Commit 87df037d authored by Eric Duminil's avatar Eric Duminil
Browse files

Update README.md

parent 5fd03b1f
# INSEL 8.3 release notes # INSEL 8.3 release notes
## Planned Timeline Current Version : INSEL 8.3 Beta7:
* For [Windows](https://bwsyncandshare.kit.edu/s/nenYqtBfkfncJxC).
* Alpha release, 19th July 2021 * For Ubuntu 20.04 : TODO
* Beta release, (hopefully) September 2021 * For Ubuntu 18.04 : TODO
* Official release, (hopefully) October 2021 * For macOS : TODO
## Timeline
* Alpha1 release: 19th July 2021
* Alpha2 release: 30th August 2021 (Mostly stable, can be used for lessons.)
* Alpha3 release: 8th October 2021 (Was too broken.)
* Alpha4 release: 8th November 2021 (Seems stable.)
* Beta5 release: 15th November 2021 (Required more testing.)
* Beta6 release: 6th December 2021 (Seems stable.)
* Beta7 release: 22nd December 2021 (Some bugfixes)
* Official release: When it's really ready.
## What's new? ## What's new?
...@@ -40,23 +51,31 @@ ...@@ -40,23 +51,31 @@
* MTM2 has 8 outputs by default. * MTM2 has 8 outputs by default.
* Same name for MTM2 outputs and GENGT2 inputs. * Same name for MTM2 outputs and GENGT2 inputs.
* D18599 block has been added. * D18599 block has been added.
* Gnuplot window does not get closed automatically with a mouse click, which lets the user interact with the graph. (Press q or click on X to close).
* It is now easier to work with Y2 axis in PLOT block (e.g. range is set and displayed automatically)
* Sun position was sometimes in the wrong quadrant, in the tropics, close to the horizon.
* PLOTP writes X/Y/Parameter and not just X/Y, so that Parameter can be used (e.g. for line colors)
### GUI ### GUI
* "Show INSEL model" has a nicer output (no trailing zeroes). * "Show INSEL model" has a nicer output (no trailing zeroes).
* Default language is English. * Default language is English.
* Default model size is 8x8. * Default model size is 8x8.
* INSEL GUI now uses Java 15. * INSEL GUI now uses Java 15+.
* New GUI themes (light/dark modes, high-contrast for accessibility, ...) * New GUI themes (light/dark modes, high-contrast for accessibility, ...)
* New keyboard shortcuts: * New keyboard shortcuts:
* <kbd>Ctrl</kbd><kbd>R</kbd> to run a model * <kbd>Ctrl</kbd><kbd>R</kbd> to run a model
* <kbd>Ctrl</kbd><kbd>P</kbd> to pause a model * <kbd>Ctrl</kbd><kbd>P</kbd> to pause a model
* <kbd>Ctrl</kbd><kbd>Z</kbd> to stop a model * <kbd>Ctrl</kbd><kbd>Z</kbd> to stop a model
* An experimental LIVECHART Block is available in the GUI. Data is displayed in real time. * An experimental LIVECHART Block is available in the GUI. Data is displayed in real time.
* The color of links can be changed globally and single links can be hidden and made visible again. * New icons (from FontAwesome).
* CLOCK block now shows progress.
* Models are not marked as changed when they are simply opened or run.
* The content of Vseit files isn't shuffled anymore anytime they are saved.
* Blocks are placed on a regular grid when imported from an insel file.
* Old INSEL 7 files (.ins, .vee) cannot be imported anymore. To import them, please use INSEL 8.2.
* The installed version can be copied to any folder (e.g. on a USB drive). Two portable bat scripts are included on windows.
### INSEL Engine ### INSEL Engine
* INSEL Core can use Fortran 90. * INSEL Core can use Fortran 90.
* Easier way to integrate and share userblocks (UB library files can have any name, e.g. `libInselAlice.dll`, `libInselBob.dll`). * Easier way to integrate and share userblocks (UB library files can have any name, e.g. `libInselAlice.dll`, `libInselBob.dll`).
* `libInselCommunity` has been created, and it contains useful user blocks from the community (e.g. `UBSTORAGE`, CHP blocks, ...). * `libInselCommunity` has been created, and it contains useful user blocks from the community (e.g. `UBSTORAGE`, CHP blocks, ...).
...@@ -65,20 +84,21 @@ ...@@ -65,20 +84,21 @@
* Can list every available block with `insel -b`. * Can list every available block with `insel -b`.
* Can list the version of every module with `insel -v`. * Can list the version of every module with `insel -v`.
* Possible to use underscores in constants : `C stuttgart_latitude 48.77` * Possible to use underscores in constants : `C stuttgart_latitude 48.77`
* Simulink blocks and logics have been removed, since they have not been used for years.
## Beta-testers: What to test? ## Beta-testers: What to test?
* Please backup every model before opening them in INSEL 8.3! (e.g. the whole `Documents/insel.work` folder) * Please backup every model before opening them in INSEL 8.3! (e.g. the whole `Documents/insel.work` folder)
* Please backup userblock libraries if you have any. * Please backup userblock libraries if you have any.
* Please backup your palette folder. (`%AppData%\INSEL`)
* Please keep an INSEL 8.2 installer, just in case. * Please keep an INSEL 8.2 installer, just in case.
* Remove INSEL 8.2. * Remove INSEL 8.2.
* Install INSEL 8.3. (+Gnuplot + GUI, MSYS2 is only needed for developing user blocks)
* Start INSEL 8.3 GUI. * Start INSEL 8.3 GUI.
* A new folder should be created at startup. * A new folder should be created at startup.
* Old models should still be readable. * Old models should still be readable.
* Old PLOT blocks should be converted. * Old PLOT blocks should be converted.
* Old coordinates should be converted. If they are defined via constants, please update constants manually. * Old coordinates should be converted. If they are defined via constants, please update constants manually.
* Can userblocks still be used? They probably need to get compiled again. * Can user blocks still be used? They probably need to get compiled again.
* Models shouldn't run slower than before. * Models shouldn't run slower than before.
* Please report any crash (with any `replay_*.log` and `hs_err_*.log` file you can find) (TODO: Where?). * Please report any crash (with any `replay_*.log` and `hs_err_*.log` file you can find) (TODO: Where?).
* A gitlab project has been created in order to collect user-feedback: https://transfer.hft-stuttgart.de/gitlab/insel/insel-8-3/-/issues * A gitlab project has been created in order to collect user-feedback: https://transfer.hft-stuttgart.de/gitlab/insel/insel-8-3/-/issues
...@@ -87,18 +107,15 @@ ...@@ -87,18 +107,15 @@
* MTMUP somehow does not update MTM weather database. * MTMUP somehow does not update MTM weather database.
* If variables are not properly initialized in blocks, they might be shared between simulation runs when run from the GUI. * If variables are not properly initialized in blocks, they might be shared between simulation runs when run from the GUI.
* Text might not be readable in dark modes.
* Name and parameters for userblocks might not be displayed correctly.
* Underscores in filenames or function names might break documentation. * Underscores in filenames or function names might break documentation.
* The "Build All" command does not compile Java classes and User Block Reference.
* UB documentation PDFs are searched at the wrong location. * UB documentation PDFs are searched at the wrong location.
* Simulink blocks have not been tested for years, and might be broken.
## What's next? ## What's next?
* Fix more bugs. * Fix more bugs.
* New GUI, based on Eclipse Sirius (with zoom / undo / web-interface / ...). * New GUI, based on Eclipse Sirius (with zoom / undo / web-interface / ...).
* Double-precision instead of single-precision floats. * Double-precision instead of single-precision floats.
* Allow blocks to be written in Python.
* PVGIS Block (month as input, coordinates as parameters, monthly average irradiances and temperatures as output). * PVGIS Block (month as input, coordinates as parameters, monthly average irradiances and temperatures as output).
* SORT Block (n inputs, data is saved during simulation, sorted at the end according to the first input, and written to a file). * SORT Block (n inputs, data is saved during simulation, sorted at the end according to the first input, and written to a file).
* READCSV Block. * READCSV Block.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment