Driver program for all tools

Aperta
#14 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
bash, cpp
Ambito
cli, tooling

Direzione di ricerca

The issue names the existing tools mppequil, checkmix, and bprime, and proposes a new mpp script in bin; it does not identify source files or tests. First inspect how the tools are built and installed, then assess how the script would dispatch commands and pass arguments. Done means one installed mpp command can invoke the listed utilities as described.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

General description

There are several programs currently included in the M++ software suite. It would be nice to have a single tool, for example mpp, which would take options to run different utilities all belonging to the software package.

Detailed description

At the moment, the various tools shipped with M++ are

  • mppequil
  • checkmix
  • bprime

as well as a few example codes. In addition, there are some utility codes which are not shipped with M++ but could be in the future, such as a reaction mechanism to latex table converter. It would be convenient and cleaner to just have a single script which could correctly call all of the appropriate tools and pass them the arguments. For example:

mpp checkmix air11

Some benefits of a mpp script would be as follows:

  • Provide access to utility codes and scripts.
  • Run example programs.
  • Present documentation of the library.
  • Could allow access to the thermodynamic, transport, and kinetic databases without having to actually find and open the files.
  • Introduce auto-completion for the options, including utility names, mixture names, etc.
  • Hide the underlying tools and codes from the environment so that there is only one tool to access everything provided by the library.
Modifications to current behavior
  • Install utilities to folder inside bin so that these are hidden from the environment when setting the path as is usually done.
  • The new script would be put in bin instead.
  • Auto-completion would require an addition file depending on the OS. For example: [https://askubuntu.com/questions/95211/how-do-i-set-up-bash-completion-for-command-arguments].
Lingua principale
C++
Stelle
145
Fork
79
Merge medio
1g 15h
PR unite (30g)
2

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di mutationpp/Mutationpp

Tutte le issue di mutationpp/Mutationpp

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.