Adding models
Upcoming feature
This is for the version from git (that you recompile yourself) or the upcoming version of Inishell!
As Inishell loads configurations for various numerical models it supports from xml files (see Principles of Inishell), it is possible to add support for new models at any time. This is done by installing a numerical model that comes with the necessary files (such as a package for installing MeteoIO for example) or installing the necessary support files.
Adding the support files
Such files are provided by the model developers as a compressed archive that can be extracted on the computer that runs Inishell. Since Inishell searches a limited number of locations on the computer, the extraction needs to take place within such a location. Please keep in mind that the directory containing such xml files must be named inishell-apps.
Easy answer
Simply copy the inishell-apps folder on your Desktop 💻, in your Documents 🖹 folders or in your Home 🏠.
Advanced answer
Inishell searches for insihell-apps folders in the following locations:
- the directory where Inishell is located, a share directory one way higher than Inishell and two directories higher than Inishell
- Desktop (usually "~/Desktop" or "~" or a localized variant)
- Documents (usually "~/Documents" or a localized variant)
- Home, "~/usr/share/doc", "/usr/share/doc" and "/usr/local/share/doc"
- "~/.local/share", "/usr/local/share", "/usr/share"
- "~/.local/share/Inishell", "/usr/local/share/Inishell", "/usr/share/Inishell"
- search locations will also be built based on the PATH and LD_LIBRARY_PATH environment variables (going one level higher and looking for a share subdirectory)
These directories are recursively searched over a depth of either 1 or 2 levels, depending on the directory.
Easy answer
Simply copy the inishell-apps folder on your Desktop 💻, in your Documents 🖹 folders or in your Home 🏠 (for example "C:/Users/<USER>").
Advanced answer
Inishell searches for insihell-apps folders in the following locations:
- the directory where Inishell is located, a share directory one way higher than Inishell and two directories higher than Inishell
- Desktop
- Documents
- Home (something like "C:/Users/<USER>")
- Program data (such as "C:/ProgramData", "C:/Users/<USER>/AppData/Local")
- App data location (such as "C:/Users/<USER>/AppData/Roaming/<APPNAME>", "C:/ProgramData/<APPNAME>")
- search locations will also be built based on the PATH environment variable (going one level higher and looking for a share subdirectory)
These directories are recursively searched over a depth of either 1 or 2 levels, depending on the directory.
Easy answer
Simply copy the inishell-apps folder on your Desktop 💻, in your Documents 🖹 folders or in your Home 🏠.
Advanced answer
Inishell searches for insihell-apps folders in the following locations:
- the directory where Inishell is located, a share directory one way higher than Inishell and two directories higher than Inishell
- Desktop (usually "~/Desktop" or "~" or a localized variant)
- Documents (usually "~/Documents" or a localized variant)
- Home, "~/usr/share/doc", "/usr/share/doc" and "/usr/local/share/doc"
- "~/Library/Application Support" and "/Library/Application Support"
- "/usr/local/share", "/usr/share"
- search locations will also be built based on the PATH and DYLD_LIBRARY_PATH environment variables (going one level higher and looking for a share subdirectory)
These directories are recursively searched over a depth of either 1 or 2 levels, depending on the directory.
Models and submodels
When working with a model that integrates another one as submodel (for example Snowpack relies on MeteoIO which can either be used standalone or as part of Snowpack), you want version consistency accross the whole models chains. This is achieved by copying the xml files for the various submodels next to one another (the internal criteria is to choose the most similar path).
For example if there is an inishell-apps directory on the Desktop and another one in Documents, each with their own copy of the Snowpack and MeteoIO xml files, the Snowpack from the Desktop will load the MeteoIO files from the Desktop while the Snowpack from the Documents will load the MeteoIO files from the Documents. If in Documents there would be no MeteoIO files, then Inishell would go to the next possible candidate location and load them from the Desktop.