Adds CAS Common API tutorial, fixes #5.

vfscalfani commented 8 months ago

Needs a reviewer maybe before merging with main. Thanks @stuchalk !

stuchalk commented 8 months ago

Vin, thanks for this I will take a look.

stuchalk commented 8 months ago

Generally, there needs to be text to explain what the code is doing in each block, where there is none currently. This does not need to be much. Something allowing the user to understand what each code statement translates to would be really helpful.

Specifically,

A little more in the introduction indicating that the different sections get more and more complicated because of the amount of data retrieved...
In block the fourth block of section 2 'vew' should be 'view' (comment)
In Section 3 'Handle' should be 'Handling' (in two subtitles)
Could you add a couple of suggestions for other things to try? Nothing big, but asking to apply what they have learned...

stuchalk commented 8 months ago

Additional checking of the Python code reveals that 'import json' present in three places is not used and thus can be deleted. In addition, the 'import numpy' in the last section is also not used...and so should be removed.

stuchalk commented 7 months ago

Vin, if you can update the PR by removing the updated _toc.yml file, then I can work on it. We are not expecting contributors to edit the TOC file ;)

vfscalfani commented 5 months ago

Thanks, TOC change should be removed now.

IUPAC / WFChemCookbook

Adds CAS Common API tutorial, fixes #5. #26