-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: update and improve install instructions
Signed-off-by: Thorsten Liebig <Thorsten.Liebig@gmx.de>
- Loading branch information
Showing
5 changed files
with
75 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,7 @@ Contents: | |
|
||
install | ||
python/python | ||
octave/octave | ||
|
||
|
||
Indices and tables | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
.. _octave_install: | ||
|
||
Install | ||
======= | ||
|
||
Instructions how to install the **CSXCAD & openEMS Octave/Matlab interface**. | ||
|
||
Requirements | ||
------------ | ||
|
||
Install Octave_ or Matlab_ and make sure openEMS and dependencies were installed correctly. | ||
See :ref:`Install from Source <install_src>` for more details. | ||
|
||
Setup | ||
----- | ||
|
||
To run the simulation scripts it is necessary to tell Octave (or Matlab) where to find the interface scripts. | ||
|
||
.. _Octave Linux Install: | ||
|
||
Linux | ||
^^^^^ | ||
|
||
On **Linux** these folders are usually located under e.g. ``/usr/share/openEMS/matlab`` and ``/usr/share/CSXCAD/matlab`` or | ||
if you installed from source (e.g. to ``/opt``) under ``/opt/share/openEMS/matlab`` and ``/opt/share/CSXCAD/matlab``. | ||
You may add this folders manually using: | ||
|
||
.. code-block:: matlab | ||
addpath('/opt/share/openEMS/matlab'); | ||
addpath('/opt/share/CSXCAD/matlab'); | ||
Alternatively you can setup these path more permanently using the "Edit"-Menu using "Set Path" in Octave. | ||
|
||
.. _Octave Windows Install: | ||
|
||
Windows | ||
^^^^^^^ | ||
|
||
On **Windows** there is only one folder to add. If you unzipped the windows build e.g. to ``C:\openEMS`` than the path would be ``C:\openEMS\matlab``. | ||
You may add this folders manually using: | ||
|
||
.. code-block:: matlab | ||
addpath('C:\openEMS\matlab'); | ||
Alternatively you can setup these path more permanently using the "Edit"-Menu using "Set Path" in Octave. | ||
|
||
.. _Octave: https://octave.org/ | ||
.. _Matlab: https://en.wikipedia.org/wiki/MATLAB |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
.. _octave_interface: | ||
|
||
Octave/Matlab Interface | ||
======================= | ||
|
||
.. toctree:: | ||
|
||
install |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters