Skip to main content

Leap Frog Optimizer

Project description

# Leap Frog Optimizer Package

<b> author : Mark Redd </b><br/>
<b> email : redddogjr@gmail.com </b>
* auto-gen TOC:
{:toc}

#### optimizer algorithm website: http://www.r3eda.com/

### about:

This optimizer was written based on the algorithm published by
Dr. R. Russell Rhinehart.
A full explanation of the algorithm can be found at the following URL:

http://www.r3eda.com/leapfrogging-optimization-algorithm/

The following are "key references" published on the optimization website
explaining the technique:

- Rhinehart, R. R., M. Su, and U. Manimegalai-Sridhar,
“Leapfrogging and Synoptic Leapfrogging: a new optimization approach”,
Computers & Chemical Engineering, Vol. 40, 11 May 2012, pp. 67-81.

- Manimegalai-Sridhar, U., A. Govindarajan, and R. R. Rhinehart,
“Improved Initialization of Players in Leapfrogging Optimization”,
Computers & Chemical Engineering, Vol. 60, 2014, 426-429.

- Rhinehart, R. R.,
“Convergence Criterion in Optimilsation of Stochastic Processes”,
Computers & Chemical Engineering, Vol. 68, 4 Sept 2014, pp 1-6.


## installation:

There are a variety of ways to install the software both for use in Python or
C/C++ on Windows and Linux.
All source code has been tested with GCC and Python 2.7. Other compilers and
Python 3 will have support in future versions.

<b>System requirements for installation from source using these instructions:</b>
- Python 2.7 or higher
- cython
- numpy
- GCC (Linux or MinGW)

#### From Source (Windows (7, 8, 10), MinGW, Python 2.7):
1. Clone or download and extract the repository.
2. If you can run Powershell scripts the `lpfgopt\lpfgopt\windows_setup.ps1` script
will do all the work for you.
Otherwise, run the follwing commands from Powershell in the `lpfgopt\lpfgopt\` path:
```powershell
> cd .\lpfgopt\lpfgopt # Get into the right directory
> make clean # clean up old files
> make # Builds with Python options. See below for more 'make' options.
> python ".\cython\csetup.py" build_ext # Build C extentions from Python source to optimize speed
> python ".\cython\cysetup.py" build_ext
> Copy-Item ".\build\lib.win-amd64-2.7\*" ".\" # Copy compiled python files to the main directory for use
> python ".\cython\csetup.py" clean # Clean up build files
> python ".\cython\cysetup.py" clean
> rm -r build # Delete the rest of the build
```
The cython commands may require you to add the C++ compiler from microsoft for Python 2.7. If this is the case follow the link to: https://www.microsoft.com/en-us/download/details.aspx?id=44266 and download and install the compiler.

2. Return to the main directory where "setup.py" is located and run the following command"
```bash
> cd ..
> python setup.py install
```
3. The software should install correctly. You may validate the installation by executing the following commands:
```python
> python
>>> from lpfgopt import __version__, unit_test
>>> __version__
'0.7.0'
>>> unit_test.main()

[ 3.00000 0.00000 0.00000 ]
[ 3.00000 0.00000 0.00000 ]

>>>
```
If the version number appears below and the above code returns no errors, congratulations! You have sucessfully installed the Leap Frog Optimizer package on your Windows machine!

#### From Source (Linux Mint 18, GCC, Python 2.7):
1. Set permissions for `lpfgopt/lpfgopt/linux_setup.sh` and run it or run the follwing commands from your terminal in the `lpfgopt/lpfgopt/` path:
```bash
$ cd ./lpfgopt/lpfgopt # Get into the right directory
$ make clean # clean up old files
$ make # Builds with Python options. See below for more 'make' options.
$ python "./cython/csetup.py" build_ext # Build C extentions from Python source to optimize speed
$ python "./cython/cysetup.py" build_ext
$ cp build/lib.linux-x86_64-2.7/* . # Copy compiled python files to the main directory for use
$ python "./cython/csetup.py" clean # Clean up build files
$ python "./cython/cysetup.py" clean
$ rm -rf build # Delete the rest of the build
```

3. Return to the main directory where "setup.py" is located and run the following command"
```bash
$ cd ..
$ python setup.py install # You may need root priviliges or use the --user tag
```
3. The software should be installed correctly. You may validate the installation by executing the following commands:
```python
$ python
>>> from lpfgopt import __version__, unit_test
>>> __version__
'0.7.0'
>>> unit_test.main()

[ 3.00000 0.00000 0.00000 ]
[ 3.00000 0.00000 0.00000 ]

>>>
```
If the version number appears below, congratulations! You have sucessfully installed the Leap Frog Optimizer package on your Linux machine!

<b>MinGW/GCC make options:</b><br/>
The following are the 'GNU make' commands that will make the needed files in
the './lpfgopt' folder
```bash
make # make all execuatble with python option
make dll # make the dll files and nothing else
make python-dll # make the dll files with the python option and nothing else
make exe # make the execuatble; only works with make dll first
make clean # erase all files made
```

- NOTE: Support for Macintosh will be added in future versions. For dylibs on
mac use the following gcc commands found on:
http://stackoverflow.com/questions/3532589/how-to-build-a-dylib-from-several-o-in-mac-os-x-using-gcc

`g++ -dynamiclib -undefined suppress -flat_namespace *.o -o something.dylib`

## Usage
[Nothing here yet]

## Removal
[Nothing here yet]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for lpfgopt, version 0.7.0
Filename, size File type Python version Upload date Hashes
Filename, size lpfgopt-0.7.0.tar.gz (6.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page