DAME-FLAME-Python-Package icon indicating copy to clipboard operation
DAME-FLAME-Python-Package copied to clipboard
verified publisher icon almost-matching-exactly

Documentation updates

Open nehargupta opened this issue 4 years ago • 2 comments

A number of small things:

  • Check the pe_frac things
  • Add paper citation, update names/contact email
  • Perhaps add the algorithm diagram from the paper somewhere too
  • (if it gets typed up) then an enhancement with a code-class-flow diagram

nehargupta avatar May 24 '21 20:05 nehargupta

I will look into this

Nanmozhi22 avatar Dec 19 '23 13:12 Nanmozhi22

Hi @Nanmozhi22 thanks for commenting and your interest. This isn't actually entirely up to date -- If you or someone wanted to jump in on documentation work, the first thing needed on the documentation is some kind of Jekyll dependency upgrade on the dynamic build for the documentation (see https://github.com/almost-matching-exactly/DAME-FLAME-Python-Package/actions/runs/7234721806/job/1971137801)

The settings in the Gemfile need to be changed basically.

nehargupta avatar Dec 19 '23 16:12 nehargupta