Giter Site home page Giter Site logo

ashao / openfoam-multi-objective-optimization Goto Github PK

View Code? Open in Web Editor NEW

This project forked from foamscience/openfoam-multi-objective-optimization

0.0 0.0 0.0 414 KB

A tiny project to use ax-platform for multi-objective optimization on OpenFOAM cases

Shell 2.12% C++ 40.73% Python 57.15%

openfoam-multi-objective-optimization's Introduction

Multi Objective Optimization on OpenFOAM cases

If you're using this piece of software, please care enough to cite it in your publications

Relying on ax-platform to experiment around 0-code parameter variation and multi-objective optimization of OpenFOAM cases.

Objectives and features

  • Parameter values are fetched through a YAML/JSON configuration file. Absolutely no code should be needed, add parameters to the YAML file and they should be picked up automatically
  • The no-code thing is taken to the extreme, through a YAML config file, you can (need-to):
    • Specify the template case
    • Specify how the case is ran
    • Specify how/where parameters are substituted
    • Specify how your metrics are computed

The scripts

  • paramVariation.py runs a Parameter Variation Study with the provided config and outputs trial data as a CSV file. Trial parameters are generated with SOBOL.
  • multiObjOpt.py runs a multi-objective optimization study (can use the same config file) and captures a JSON snapshot of the experiment. You can also run it with a single objective.

How do I use this?

The only requirement of usage (aside from being able to install dependency software) is that your template case needs to be ready to be parameterized.

# Clone the repository
git clone https://github.com/FoamScience/OpenFOAM-Multi-Objective-Optimization multiOptFoam
cd multiOptFoam
# Install dependencies
pip3 install -r requirements.txt
# Run parameter variation with config.yaml on pitzDaily case
./paramVariation.py
# Or run a multi-objective optimization
./multiObjOpt.py

Docs and Sample configuration

You can find a quick tutorial in the docs page. The sample config file and case are also documented.

Contribution is welcome!

By either filing issues or opening pull requests, you can contribute to the development of this project, which I would appreciate.

openfoam-multi-objective-optimization's People

Contributors

foamscience avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.