Skip to content
/ PODS Public

An optimization toolbox for computing expensive environmental models

License

Notifications You must be signed in to change notification settings

louisXW/PODS

Repository files navigation

opdelft

About

An optimization toolbox for computing expensive environmental models (e.g. Delft3D models). The toolbox coupling advanced optimizaiton method with real problems. The documentation of opdelft refer to https://louisxw.github.io/opdelft/

Install

Preparing your system to use opdelft

  1. python & pySOT

Before starting you will need to Python installed. Recommend python 2.7 since opdelft was developed and tested based on this verison. You will need to have pySOT (0.1.36) installed. Other python module like (poap, scipy, numpy) needed will be installed automatically once the pySOT is installed.

To install the pySOT (0.1.36) package with conda run one of the following:


		conda install -c conda-forge pysot

or

		conda install -c conda-forge/label/gcc7 pysot

pySOT is a open source toolbox is for optimization of computationally expensive black-box objective functions. more information about pySOT refer to: https://pysot.readthedocs.io/en/latest/index.html

  1. Delft3D

To work with Delft3D problem you may need to have Delft3D installed.

Delft3D is an open source software which simulates two-dimensional (in either the horizontal or a vertical plane) and three-dimensional flow, sediment transport and morphology, waves, water quality and ecology and is capable of handling the interactions between these processes.

The Delft3D installation manual on both windows and linux links to https://content.oss.deltares.nl/delft3d/manuals/Delft3D-Installation_Manual.pdf

You may also want to compile the open source on your platform. The instruction links to https://oss.deltares.nl/c/document_library/get_file?uuid=e3bf2d05-f59f-4d4a-8c13-97bcbaa84060&groupId=21119

Install opdelft on your system

There are two options to install opdelft

  1. install from repostitory with setup.py

| 1.1. Clone the repository:

		git clone https://github.com/louisXW/opdelft.git

| 1.2. Navigate to the folder with setup.py file:

		cd opdelft/opdelft

| 1.3. Install opdelft with setup.py if you have admister root

		python setup.py install		

| 1.4. Most cases you might work on a remote workstation without root. Install opdelft with setup.py locally

		python setup.py install --user
  1. install with pip (option avaiable onece the repository is public)
		pip install opdelft	

About

An optimization toolbox for computing expensive environmental models

Resources

License

Stars

Watchers

Forks

Packages

No packages published