sinoftheta / cs46x-group40

Ground water simulation library, ported from Fortran

Virtual Env

Setting up a virtual environment is something that each developer needs to do. This is done by moving into the python directory and running:

$ python3 -m venv env

This creates a directory called env. Note that this directory is in the .gitignore.

After creating this directory the following workflow should be used:

# enable vitual env
# on mac/linux
$ source env/bin/activate

# on windows
$ .\env\Scripts\activate.bat

# make sure the virtual env has all the required libraries
$ pip install -r requirements.txt

# program as one normally would

# when finisihed programming, make sure any new libraries are added to the requirements.txt
$ pip freeze > requirements.txt

# deactivate env
$ deactivate

# deactivate env on windows
$ .\env\Scripts\deactivate.bat

# do git stuff
$ git add/commit/push

Extra Notes On Windows

working on windows is a pain, I recommend using either linux or mac. Client has a mac, so windows comes 2nd or 3rd.

Installing GSL

Main website here. On the downloads page look for version 2.6.

Linux/Mac

Download gsl-2.6.tar.gz.

$ tar -xf gsl-2.6.tar.gz
$ cd gsl-2.6
$ ./configure
$ make
$ sudo make install

Windows

Windows is a touch more involved. Using msys2 as a build tool has worked the best.

Follow these instructions for installing msys2 and c build tools. You do not need to install the boost library. You will, however, need to install GSL.

In msys2 shell:

pacman -Ss gsl

Gives a list avalible gsl distros to install, find gsl-2.6 and install that one.

Compiling Standalone C Code

Our C Code relies on the GSL library, so make sure that was installed. Note that the standalone C code exists as a means to debug the C library in C.

Linux / Mac

CD into the c-source directory and run the Makefile. To execute the code, run make run.

Windows

Presumably the steps in the Installing GSL section were followed, so all tools should be avalible.

CD into the c-source directory and run the Makefile using mingw32-make.exe. You might encouter an issue with the mkdir command. Its a dirty fix, but comment it out and create the following directory structure under c-source

c-source/
    build/objs/src/
        capstone/
        gs2/

Building Standalone Application

Overview

Running one of the build scripts creats a top-level directory, dist. In dist there is an executable main. Running main should launch the application.

• Compile C library with make library
• Bundle python code with pyinstaller --hidden-import pkg_resources.py2_warn main.py --onefile
• Copy C dependecies and sim library into the dist folder created by pyinstaller.

Linux / Mac

Running $ bash build.sh should be enough to produce an application.

Windows

Running the build.bat file should be enough to produce an application.

Running Python by itself

running main.py works just fine. It uses a development config file. Requires that the code in c-source was built into a library.

cs46x-group40's Issues

C Port Task0

Create a struct for GS2 containing all "global" variables

Update readme to include information on environment manager

As a developer, it would be beneficial to have a local set of instructions for using virtualenv

C Port Task1

Port the Datain section of the program graph:
Datain
BC
ICS1CU

Create Program Data flow Diagram

As a developer I would like a high-level overview of the project as to be able to see how each piece fits together.

At the end of this task a wiki page should be made that links to the flow diagram.

f2py - call entire simulation

C Port Task2

Port the COGEN section of the program graph.

cogen
qz
shape
matgen

f2py - substitute system calls

Import Group Q

C Port Task4

Port the Main and TS sections of the graph

main
ts
upd

this task should be done last

Import Group C

Create screen to show mesh

As represented by figure 15 in the design document.

As a user I would like the ability to run the simulation and see its output.

C Port Task3

Port the following subroutines called by TS

gleb
sband
dband
array

Import Group O

f2py - call a single subrutine/demo

Import Group I

Create screen to set nodal information

As represented by figure 13 in the design document.

As a user I want screen that will let me specify what information I want each node to have.

Bug in Common One

In Common One, I dont see bwd or cntr, however I also cant find documentation for them or where they are used.

I also don't see: coefi, ei, iter1, itmax, itchng, igo.

Originally posted by @IanBand in #47

Develop Script for running pyinstaller

As a developer I would like the ability to run a script to build an executable, instead of manually running pyinstaller.

This script should run on windows, mac, and linux.

Create variable initialization screen of gui

This is represented by figure 12. in the design document.

As a user I want a screen that will let me set specific multiplier variables.

Create Main Screen of GUI

This is represented by Figure 11 in the design document.

As a user I want a graphical user interface that allows me to set the primary variables in the simulation.

Create screen to set element data

As represented by figure 14 in the design document.

As a user I would like the ability to edit the information for each element.

Import Group D

change Array.c and Matrix.c to be 1 indexed

Import Group J

Import Group G

Create interactive mockup of GUI

As a developer I would like an interactive mockup for the GUI as to know how each screen connects to each other screen

The deliverable item for this task should be placed into our shared drive. In addition a wiki page here on github should be made that briefly talks about the mock up and links to the drive.

Create C directory for project

We need a location to house our C source code.

C Port Brian's Task

port the following subroutines called by TS

zero (this should be done already)
lrhs
asembl
green

Update wiki to include information about the project board.

Create a wiki page describing what each column represents.