Skip to content
Nate Harms edited this page May 29, 2019 · 16 revisions

Welcome to the Project Wiki for the Kinetic Models Site!

The goal for this website is to add more robust and user-friendly searching functionality for the database of combustion kinetics. In particular the goals of this project will be focused specifically on the needs of the graduate students within the lab in addition to the goals of the average user from the combustion chemistry community. We intend to look at the search forms on sites like PrIMe, NIST, CloudFlame, and RESPECTH and try to improve our User Interface and User Experience (UI/UX) based on what they've already done.

This can mean:

  • Expanding the database search forms to allow for greater searching flexibility;
  • Bringing the website up to the latest standards within the Django framework;
  • Incorporating frameworks like jQuery, Bootstrap, and FontAwesome to meet trends in modern web design;
  • Creating custom stylesheets and logos to emphasize the distinction between pr.omethe.us and its older competitors.

Because the current priority is the searching functionality of the website, a large portion of the work will necessarily be done by studying the existing models. The first step involves looking at the models and their fields, and deciding how to design a form to search through them as thoroughly and intuitively as possible. Then we will have to create new Django Forms objects to add to existing views, and write functions that utilize Django's model-query syntax to pull the desired results succinctly and pythonically. Once a branch of the website has code for this added searching functionality, the plan according to Dr. West is to get a dedicated machine in 009G on which we can further develop the website via localhost:8000.

At that point we will need to run tests on the website, first for the accuracy and completeness of the search results. One challenge in particular will be writing automated tests using Django's self-testing syntax for the database searches, since the search results themselves may change as more entries are added to the database. A second stage of testing will involve the website's user-friendliness, working closely with the other members of the CoMoChEng group. The goal is to have the new search forms complete and ready for UI/UX feedback by the end of February.

At that point we can transition into experimenting with styling the website. I am currently studying different tools for creating and manipulating dynamic graphics on webpages. Coming into the lab with no experience with JavaScript and with basic experience with HTML and CSS, I am working independently to become more proficient in web development idioms. I have been pursuing the front-end web development certification on FreeCodeCamp.com, which covers modern HTML/CSS, JQuery, BootStrap, and functional and object-oriented JavaScript. I have also begun reading Supercharged JavaScript Graphics, by Raffaele Cecco. I plan to complete both the online course and the book by the end of February, to coincide with the completion of the new search forms.


Just leaving this here...


From Importer / Database Meeting on 5.28.2019

General ToDo:

  • Update RMG-Models to be readable thermo and kinetic libraries using the current branch of RMG
    • Use a version of RMG-2.4.0 to read in Chemkin files with species dictionaries to parse everything in
    • Edit RMG source code to solve errors that we come across
      • Expected to run into issues with 3 and 4 body reactions
      • Possible pull requests:
        • Adding 3 and 4 body reactions (and whatever is needed to read in all Chemkin files assuming we know the species)
        • Adding in methods to interpret the species and guessing of unknown species
          • Possibly done by rewriting or attempting to merge in old code
  • Create Django Database
    • Port over Kian's Models / make our own
      • Reach out to Kian and possibly cherry pick what all we need
    • Extract info we need from an updated model and formally make a lite version of the database for testing website front end
    • Extract info from the rest of the updated models to make the full version of the database
  • Website functionality / design
    • Changes to website templates
      • Molecule searches:
        • All models with X in them
      • Thermo search results: (tabular)
        • Model Name
        • Reference (leading to a Reference page)
        • Species Name / Number in the model
        • Delta H and S @ 298 K
        • Cp at a specific temperature or at a range of temperatures
        • Thermo (leading to a Thermo page)
      • Kinetics search:
        • All reactions with X in them feature rather than exact match to given reactants
      • Kinetics search results: (tabular)
        • Model Name
        • Reference (leading to a Reference page)
        • Reaction Name / Number in the model
        • Kinetics Type
        • k @ 1000, 2000 K and @ 1 bar, 10 bar
        • Kinetics (leading to a Kinetics page)
      • Reference search results: (tabular)
        • year
        • author(s)
        • facility, location
        • containing species
    • Aesthetics
      • Branding
      • Figure design
    • Submitting models:
      • Validation (using PyKED's tools?)
      • Related to Chao's Google Summer of Code
        • Find bugs in Cantera and Chemkin input files and help users address them
    • AutoTST
      • Would you like to submit this reaction to AutoTST?
  • Stories
    • Come up with a list of stories that describe what users might want to do with our website
    • Turn these stories into features