lab-cosmo / chemiscope

An interactive structure/property explorer for materials and molecules
http://chemiscope.org
BSD 3-Clause "New" or "Revised" License
121 stars 29 forks source link

Lots of stuff out of date in the documentation #259

Closed ceriottm closed 8 months ago

ceriottm commented 1 year ago

Chemiscope has evolved a lot over the past year, and the documentation needs to be updated a bit. Things I noticed quickly, probably more to find:

Bonus: figuring out how to make sure the documentation doesn't get out-of-date again.

Luthaf commented 1 year ago

The about box mentions GPL license for JMol, but we don't use JMol anymore

Will be fixed by #256

The example of usage of the web components, https://chemiscope.org/docs/embedding.html#usage-example doesn't seem to work (or at least, we should explain how that HTML can be used

I'll have a look, but this code is missing the dataset loading part, meaning one can not just copy/paste it around.

jwa7 commented 1 year ago

Just to add to this - there should be a section in the README that highlights that chemiscope can be easily installed for use in jupyter notebooks simply by using pip install chemiscope and not going through all the npm build/install process