by

Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Activity
    Didier
    @Didou09
    @lasofivec , I have a few minutes of spare time between shots, I'm proposing Pull Requests to solve tiny issues (187, 188, 189...) from time to time.
    Putting you as reviewer for the ones you opened to keep you informed (so you don't try to solve them too)
    @flothesof Thanks a lot for your help !!!
    Laura S. Mendoza
    @lasofivec
    Awesome :)
    I left all these issues to you for the moment, solve them whenever you want. I want to work today on the documentation
    We had a call with @flothesof, we decided:
    • We are gonna update the general look of the documentation. Probably make it more concise but most of all more focused towards examples / tutorials
    • Florian is gonna give us a hand in the general structure of the sphinx-gallery part, to have something similar to this: https://nilearn.github.io/auto_examples/index.html#
    • I'll be editing the examples, probably will need a hand from you @Didou09 for some of the generating scripts (if for starters we could re create the ones in the README.rst). I think that would be really nice
    • We are gonna setup the documentation as a step of the CI with travis.
    Laura S. Mendoza
    @lasofivec
    If I forgot something, please let me know Flo :) I think it's also good we get a summary here FTR
    Didier
    @Didou09
    Good decisions, focusing on example and tutorials is definitely the way to go for this 3-years old doc. And building it as part of CI is definitely good practice. It will also allow to store each tofu version with its corresponding doc
    Florian LB
    @flothesof

    Good decisions, focusing on example and tutorials is definitely the way to go for this 3-years old doc. And building it as part of CI is definitely good practice. It will also allow to store each tofu version with its corresponding doc

    This is where it gets tricky. I see how having the full history of docs could be interesting in the long term, but since I'm not familiar with how to do this, I would suggest that in the short term we just keep one version of the documentation: the most up to date one.

    I have ported the getting started example from the wiki to a .py script formatted for sphinx-gallery but I'm hitting one of the remaining longlong bugs (as discussed in ToFuProject/tofu#95). I'm going to push that branch so that @lasofivec can check it out
    Florian LB
    @flothesof
    Just submitted a pull request with my changes. @lasofivec could you tryout that branch and see if you can build the docs correctly? I inserted a link to the gallery in the index.rst, you should be able to access it from there.
    Florian LB
    @flothesof
    Some more changes: the example works on my machine and generates a nice start for the gallery.
    It's nice to finally see some 1D LOS and 2D LOS and the interactive plots :)
    Laura S. Mendoza
    @lasofivec
    I'm going to try it rn ! I'll let you know asap.
    Quick question @flothesof by any chance do you know how to force the inclusion of files starting with _ (underscore) to the apidoc ? All our files in geom start with an underscore so they are all being ignored, which kind of kills the automatic aspect
    Didier
    @Didou09
    Ok, I pulled the sphinx_gallery branch on CentOS at work between 2 shots, any quick hint at how to build the gallery from command line ?
    Laura S. Mendoza
    @lasofivec
    go to tofu/doc/
    make html
    (it will automatically make the gallery as well)
    then open tofu/doc/build/index.html
    you should see a new link to the gallery
    Didier
    @Didou09
    Thanks,
    currently installing sphinx-gallery package to get the whole thing running
    Laura S. Mendoza
    @lasofivec

    then open tofu/doc/build/index.html

    open tofu/doc/build/html/index.html

    Florian LB
    @flothesof

    Quick question @flothesof by any chance do you know how to force the inclusion of files starting with _ (underscore) to the apidoc ? All our files in geom start with an underscore so they are all being ignored, which kind of kills the automatic aspect

    I have no idea...

    Laura S. Mendoza
    @lasofivec
    FTR: sphinx-apidoc -f -P -o source/ ../tofu/ {../*test*,../*mag*,../*imas2tofu*} -P
    I'm using this to get the sphinx auto generated doc. So I'm ignoring imas dependent modules
    Laura S. Mendoza
    @lasofivec
    sphinx-apidoc -f -P -d 5 -o source/ ../tofu/ {../*test*,../*mag*,../*imas2tofu*,../*geom/inputs}
    Laura S. Mendoza
    @lasofivec
    Well, I think it looks like I changed nothing at all but the branch gh-pages is a brand new one :sweat_smile:
    I am going to add a tuto on how to update the doc somewhere even though we wont need to do it probably (unless re structuring of the library)
    Florian LB
    @flothesof
    Hey Laura, I just checked the updated documentation. It looks fantastic!
    I think it would be great to change the structure a little bit by adding installation instructions
    I would say as the first bullet point in the contents
    Laura S. Mendoza
    @lasofivec
    Yes that's on my TODO for today :)
    and thanks :)
    Laura S. Mendoza
    @lasofivec
    Didier
    @Didou09
    The new version of the doc is a really great fresh start !
    Thanks very much to both for all that nice work, while I was on sick leave.
    I got back yesterday, and I'll try to catch up from now
    I might suggest to switch to a different theme in order to stick better to the theme of some other IMAS-related libraries with which we are now cross-compatible (successfully tested yesterday), like IMASViz, a GUI for easy plotting of IMAS data (IMAS being a fusion-community data base format). The next version of IMASViz will have an official tofu plugin, so most tofu interactive figures will be automatically generated from the IMASViz GUI :-)
    Laura S. Mendoza
    @lasofivec
    I'll write this here FTR. I propose we submit something to Matplotlib's new blog:
    https://matplotlib.org/matplotblog/
    They published it on twitter and it looks like they are aiming at "academics", which is great for us.
    Since there is only one post for the moment, I think we could get a lot of clicks if we contribute.
    Plus, during the PyConFR conference people complimented the great work of didier for the GUI :)
    Didier
    @Didou09
    here :-)
    I confirm that the only remaining problem is numpy : hard-coding the np.get_include() path solves everything !
    Didier
    @Didou09
    see issue, I hadded links for record
    Laura S. Mendoza
    @lasofivec
    wjat are you trtying rn ?
    Laura S. Mendoza
    @lasofivec
    the two PR (one with the meeting summary) are open :)
    Laura S. Mendoza
    @lasofivec
    did this solution work ???
    Laura S. Mendoza
    @lasofivec
    Found the link that I couldn't find during the meeting
    "Note PyPI currently supports uploads of platform wheels for Windows, macOS, and the multi-distro manylinux1 ABI. Details of the latter are defined in PEP 513."
    https://packaging.python.org/guides/distributing-packages-using-setuptools/