search

Ex-Mente / auxi.0

GNU Lesser General Public License v3.0
8 stars 8 forks source link

Move the chemistry tool examples in the user docs to Jupyter examples #140

Closed SShilo closed 8 years ago

SShilo commented 8 years ago

Background Improvements have been made to Stoichiometry Calculations.rst and Thermochemistry Calcuations.rst. These improvements include the changing the code from static .rst to a more dynamic .ipynb. Minor challenges have been met, but progress has been made.

Purpose To upgrade the Stoichiometry Calculations.rst and Thermochemistry Calcuations.rst files into .ipynb file.

Approach Anaconda 3.5 was downloaded and jupyter was used to create the file attached. Most of the .rst file was changed into either Markdown, Headings or code to allow interaction. Where technical limitations were met they were displayed as comments(especially putting a markdown between the code and the expected outcomes)

Notes: The structure of the file can be improved by allowing sphinx to do its work of styling the markdown and headings, but the pip install in anaconda did not help. : An install of auxi needs to be made in the anaconda environment.

SShilo commented 8 years ago

ISSUES 118 and 119. The examples will follow.

coveralls commented 8 years ago

Coverage Status

Coverage remained the same at 76.025% when pulling e1c2e81964e7bc2fda108351f616bfbf489f0734 on SShilo:Simon-Shilo-contributions into 90559c8dfa9203a11032e9df08504a7488e1537d on Ex-Mente:develop.

christoffkok commented 8 years ago

Hi Simon,

Thank you very much!

These 2 new Jupyter notebooks should exist the src/example/tools/chemistry folder (the chemistry folder should be created.).

Will you name then stoichiometry_calculations and thermochemistry_calculations?

Our file naming conventions aren't documented. I will add an issue for this.

christoffkok commented 8 years ago

Hi Simon,

I changed the name of the issue to: "Move the chemistry tool examples in the user docs to Jupyter examples"

I also created a new branch for you on Ex-Mente/auxi.0 against which you can submit a pull request. Will you fix those issues and submit a pull request against the issue-140 branch?

Kind Regards, Christoff

christoffkok commented 8 years ago

We will add your changes to next week's auxi release.

johanzietsman-em commented 8 years ago

You addressed both issues 118 and 119 in this pull request. You may only address a single issue per pull request.