README

What is this repository for?

This repository contains python programs for the design of optimal transport network via Dynamic Dynamical Monge-Kantorovich (DMK) model [^1 , ^2 , ^3]

Version * 2.0

How do I get set up?

Dependencies

• INSTALLED PROGRAMS/LIBRIERIES
  • Fortran compiler compatible with FORTRAN 2003 (gfortran v>=4.8 )
  • Cmake (version>=2.8)
• INSTALLED PROGRAMS/LIBRIERIES
  • Blas/Lapack libraries
• EXTERNAL REPOSITORIES: Clone the following repositories in the directory external using the command

git submodule init;
git submoudel update --remote

* https://gitlab.com/enrico_facca/globals.git        
* https://gitlab.com/enrico_facca/linear_algebra.git 
* https://gitlab.com/enrico_facca/geometry.git 
* https://gitlab.com/enrico_facca/p1galerkin.git 
* https://gitlab.com/enrico_facca/dmk_solver.git

• PYTHON >=3.6 and PACKAGES
  • numpy (MANDATORY) "pip3 install numpy"
  • click (RECOMMENDED "pip3 install click" )
  • meshpy (RECOMMENDED "pip3 install meshpy" )
  • f90wrap (MANDATORY for fortran-python interface "pip3 install f90wrap")

Compile

In Unix-base dsystem use the classical Cmake commands to compile libraries and programs:

  mkdir build/;
  cd build;
  cmake ../; 
  make

How to run tests

Move into the srcs/ directory and run

jupyter-notebook

Deployment instructions

We adpot the GitFlow approach

Contribution guidelines

• Writing tests
• Code review
• Other guidelines

Who do I talk to?

• Repo owner or admin
  • Enrico Facca ([email protected])
  • Mario Putti ([email protected])
• Other community or team contact

References