Skip to content

Commit

Permalink
Update README (#24)
Browse files Browse the repository at this point in the history
* Update README

* Fixes
  • Loading branch information
AnHeuermann committed Feb 16, 2023
1 parent 66b920b commit 8216eae
Showing 1 changed file with 17 additions and 18 deletions.
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,32 @@ OpenModelica sensitivity analysis and optimization module.

## Dependencies

- [OpenModelica](https://openmodelica.org)
- [Python >= 3.6](https://www.python.org/)
- [Python setuptools](https://pypi.org/project/setuptools/)
- [OpenModelica](https://github.com/OpenModelica/OpenModelica)
- [Python >= 3.6](https://www.python.org/)
- [Python setuptools](https://pypi.org/project/setuptools/)

## Supported platforms

- Windows
- Linux
- Windows
- Linux

## Build/Install instructions

### Windows
Follow the instructions matching your OS:

OMSens is installed automatically with OpenModelica on Windows.
If you still want to build it then setup the [Windows environment](https://github.com/OpenModelica/OpenModelica/blob/master/OMCompiler/README-OMDev-MINGW.md).
Once the environment is ready then run the makefile.
- [OMCompiler/README.Linux.md](https://github.com/OpenModelica/OpenModelica/blob/master/OMCompiler/README.Linux.md)
- [OMCompiler/README.Windows.md](https://github.com/OpenModelica/OpenModelica/blob/master/OMCompiler/README.Windows.md)

```bash
cd /path/to/OpenModelica
make -f Makefile.omdev.mingw omsens
```
### Windows MSYS Makefiles

If you used MSYS Makefiles to compile OpenModelica you need one additional step:

OR
Start a MSYS terminal `$OMDEV\tools\msys\mingw64.exe` (64 bit) or
`$OMDEV\tools\msys\mingw32.exe` (32 bit) and run:

```bash
cd /path/to/OpenModelica/OMSens
make -f Makefile.omdev.mingw OMBUILDDIR=/path/to/OpenModelica/builddirectory
$ cd /path/to/OpenModelica
make -f Makefile.omdev.mingw omsens -j<Nr. of cores>
```

### Linux
Expand All @@ -46,5 +45,5 @@ $ python setup.py install

## Bug Reports

- Submit bugs through the [issues](issues).
- [Pull requests](pulls) are welcome.
- Submit bugs through the [OpenModelica GitHub issues](https://github.com/OpenModelica/OpenModelica/issues/new).
- [Pull requests](../../pulls) are welcome ❤️

0 comments on commit 8216eae

Please sign in to comment.