Code Monkey home page Code Monkey logo

epanetmsx's Introduction

EPANET-MSX 2.0

The EPANET-MSX 2.0 is a free software program and can be used to model water quality problems involving multiple components. EPANET-MSX will only run correctly with release 2.2 or higher of the EPANET2 engine.

Build Status

Build and Test

Build Instructions

CMake (https://cmake.org/) can be used to build EPANETMSX applications. The project's CMake file (CMakeLists.txt) is located in its root directory and supports builds for Linux, Mac OS and Windows. To build the EPANETMSX library and its command line executable using CMake, first open a console window and navigate to the project's root directory. Then enter the following commands:

git submodule init
git submodule update --recursive
cmake -B build .
cmake --build build --config Release --target package

Documentation

EPANET-MSX manual can be found here: MSX manual

epanetmsx's People

Contributors

cbuahin avatar dbhart avatar fengshang1972 avatar lrossman avatar ucchejbb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

epanetmsx's Issues

Use a different MAGICNUMBER in the EPANETMSX binary file format to distinguish it from EPANET

EPANET uses a MAGICNUMBER to "identify" the binary output file as having been written by itself. EPANET and EPANET-MSX both use the same MAGICNUMBER and write it to the header and footer of the binary output file.

Since they format the binary data differently, it would be useful to use a slightly different MAGICNUMBER in MSX so that it would be easy to distinguish between binary files written by EPANET from those written by EPANETMSX after the fact.

This would allow us to provide more meaningful error messages to users or write a library that supports both formats.

Advise Users to Check for Machine-Specific Architecture Flags

I wanted to recommend that in the instructions/documentation for compiling using the makefile that users check for machine-specific architecture flags. In the past, I compiled epanetmsx on a supercomputing cluster, and had initially had very slow run times because I was not aware of the modifications I needed to make to the makefile. After updating the makefile with the correct architecture flag, the runtime of epanetmsx was as I expected (much faster).

When fixing this issue, here are resources I found helpful:

https://stackoverflow.com/questions/45933732/how-to-specify-a-compiler-in-cmake
https://stackoverflow.com/questions/11783932/how-do-i-add-a-linker-or-compile-flag-in-a-cmake-file

And here is the modification I made to the makefile in my case:

SET(CMAKE_C_COMPILER "icc")
SET(CMAKE_C_FLAGS "-xCORE-AVX2 -axCORE-AVX512,MIC-AVX512")

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.