HMD Mathematics Files

------------------------------------------------------------------------------
README   HMD Mathematics 4.4.35
------------------------------------------------------------------------------

Welcome
-------

This is a Windows version of the HMD Mathematics program.  HMDMathematics is
a program for numerical mathematics incluing ordinary differential equation
(ODE) solvers and finite element (FE) solvers.


Installation
------------

Run the hmd_4_4_35.exe file as Administrator.  Use the default installation
target directory, or choose your directory.  But your directory name must not
have spaces in the name.


Help
----

There is documentation for HMDMathematics at the web site

    http://heldenmathmodeler/sourceforge.net

In addition, the program has a help feature.  From the interpreter command line
type
    help 'help';
to see a list of help topics.  Then get help on a specific topic with
    help 'some topic';

There is a Help menu option from which a list of help topics may be selected.

There examples on how to use HMDMathematics included in the share folder in
    share\hmd\examples
    share\hmd\ATP


Working Directories
-------------------
If you want to start up the program in a different directory than the
installation directory,  you should not copy the program executable to
your working directory.  It would be better to Create your own desktop
shortcut with start up parameters that reference the share folder:

    1.  Create your own desktop shortcut

    2.  In the shortcut Properties / Target, put the path to the installation
        folder and program file,

            <installation path>\Hmd\hmd.exe  -j  -s <share path>

        The <installation path> by default is C:\HMDMathematics.  If you
        installed it somewhere else put that path.  The <share path> is
        the directory path, in Unix format, to the share folder in the
        installation folder.  So, if the installation folder was
        C:\HMDMathematics, put for the <share path>

            /HMDMathematics/Hmd/share/hmd

    3.  Instead of adding the -s parameter to the shortcut properties,
        you could just copy the hmd_config.cfg file from the installation
        folder into your working directory.

    4.  In the shortcut properties, in thje "Start in:" entry box, put your
        working directory.

If you want your shortcut to show the HMDMathematics icon you can do this by
clicking the "Change Icon" button in the shortcut properties.  Browse to the
directory where tou installed the program (by default C:\HMDMathematics).
Browse to the Hmd subfolder.  Select the file "Hmd_Icon.ico" and continue
with the Ok and Apply buttons.


Plots
------

The Windows version of HMD Mathematics does not yet have an interface to
Gnuplot, which is its standard plot tool.  This is a TBD for future Windows
builds.  For now there is a simple plot feature by clicking the [Data list]
tab, and click the Data Variables button.  A list of all applicable arrays
defined in the user workspace will be listed.  Select one of the arrays shown
and click the View Plot button.  The data will be display as a simple line
plot.


Troubleshooting
---------------

If anything goes wrong with program execution first be sure that the
installation path does not include any spaces.  There is a warning about this
during the setup process.  For example, "C:\Program Files" is not allowed.

If the install path is valid but there is still a problem with execution
check the following:

    1. During installation, a folder called "share" is installed into the same
       directory as hmd.exe, but you could put the share folder anywhere
       on the computer.  This folder contains files needed for HMD execution.
       The HMD program needs to know where it can find the share folder, so
       it tries to read a file called "hmd_config.cfg" in the folder where
       it starts up.

    2. On Windows the hmd_config.cfg file must be present in the folder
       whereever HMD starts up.  HMD reads this file to obtain the path to its
       "share" folder.  This is a feature that allows the HMD program to be
       run from different working folders and be able to retain separate
       working sessions.

    3. The hmd_config.cfg file must contain a line

           hmdsharepath /HMDMathematics/Hmd/share/hmd
                        -------------------
                                |
                        installation folder

        Notice that this line contains the keyword "hmdsharepath" at the
        beginning and is followed by the full path to its dependency files.
        If, for some reason, you moved the share folder somewhere else, say,
        under C:\Work\programs, then the line would be

            hmdsharepath /Work/programs/share/hmd

        In other words, the path shown in the hmd_config.cfg file must show
        the path to the share folder followed by "/share/hmd".

        Finally, notice that the file path separator symbols in the
        hmdsharepath line are forward slash characters (a / symbol) not
        backslash (a \ symbol) characters as would be normally used on Windows.


author:
    Alfred Steffens Jr,  5-6-2018